{"items":[{"type":"link","label":"Creditsafe Connect","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi","content":{"contentType":"overview","meta":{"name":"Creditsafe Connect"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"connectAPI.json","url":"/_bundle/connect-apis-catalog/product-catalog/Connect-API-Full/connectAPI.json?download"},{"kind":"download","label":"connectAPI.yaml","url":"/_bundle/connect-apis-catalog/product-catalog/Connect-API-Full/connectAPI.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":"Creditsafe Connect (1.10.9)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[]}],"sectionId":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi"}],"sectionId":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi"},{"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":"This is the full Connect API and contains all available endpoints. For additional information, integration processes, and supplementary documentation, please use the targeted product"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Creditsafe Connect API is a REST API that provides access to the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://www.creditsafe.com/gb/en/more/about/our-data.html","target":"_blank","rel":"noopener noreferrer"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creditsafe Global Company Database (opens in new tab)."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This allows you to: "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"ul","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Control your master data"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Utilize up-to-date Business and Director information, enhancing your onboarding and qualification processes"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Receive alerts when your customer's and supplier's Credit Report changes"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]}]}],"sectionId":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/section/introduction"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/introduction/quick-start"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Quick Start"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To start your Creditsafe Connect API integration you will need to have activated your account and set a password by following the instructions in your Welcome Email. If you have not received a Welcome Email please contact your Creditsafe Account Manager."},"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":"By default, you will have been setup on our Sandbox environment."},"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":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Using a REST API client construct an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/authenticate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" POST request and enter your username & password (case-sensitive) into the POST body. A successful response will return an  "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authentication token"},"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":"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":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authentication token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header on all other Creditsafe Connect calls as proof of your authenticity."},"children":[]}]}]}]}],"sectionId":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/section/introduction/quick-start"}],"sectionId":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/section/introduction/quick-start"}]}]}},{"type":"group","label":"Introduction","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/section/introduction","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/section/introduction","items":[{"type":"link","label":"Quick Start","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/section/introduction/quick-start","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/section/introduction/quick-start","content":null}],"content":null},{"type":"separator","label":"Access","content":null},{"type":"group","label":"Authentication","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/authentication","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/authentication","items":[{"label":"Authenticate","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/authentication/authenticate","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/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":"Endpoints for user authentication into the Connect API."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/authenticate","summary":"Authenticate","prefix":{"name":"post","color":"post"},"badges":[],"link":"/authentication/authenticate","deprecated":false}]}]}]}]}},{"type":"group","label":"User Administration","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/user-administration","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/user-administration","items":[{"label":"Return Subscription Details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/user-administration/subscriptiondetails","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/user-administration/subscriptiondetails","metadata":{"seo":{"title":"Return Subscription Details","description":"Returns the available countries in your subscription - Company Report, Director Report, Offline Reports and Monitoring."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"subscriptionDetails","name":"Return Subscription Details","isWebhook":false,"pointer":"/paths/~1access/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return Subscription Details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the available countries in your subscription - Company Report, Director Report, Offline Reports and Monitoring."},{"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":"/access","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"],"pointer":"/access","href":"user-administration/subscriptiondetails","openApiOperationId":"subscriptionDetails","summary":"Return Subscription Details"},"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/ConnectAuthenticationAccessCountries"}},"schemaId":"components/schemas/ConnectAuthenticationAccessCountries"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}},"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}],"pointer":"/paths/~1access/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConnectAuthenticationAccessCountries","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectAuthenticationAccessCountries"}}},{"code":"400","schemaId":"components/schemas/ConnectErrorResponsesBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}}},{"code":"401","schemaId":"components/schemas/ConnectErrorResponsesInvalidToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user-administration/subscriptiondetails"}],"panels":[]}]},"httpPath":"/access"},{"label":"Return List Of Active Users","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/user-administration/protectgetactivecustomerusers","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/user-administration/protectgetactivecustomerusers","metadata":{"seo":{"title":"Return List Of Active Users","description":"Returns a collection of user details with in the customer"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"protectGETActiveCustomerUsers","name":"Return List Of Active Users","isWebhook":false,"pointer":"/paths/~1access~1users~1active/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return List Of Active Users","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a collection of user details with in the customer"},{"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":"/access/users/active","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","404"],"pointer":"/access/users/active","href":"user-administration/protectgetactivecustomerusers","openApiOperationId":"protectGETActiveCustomerUsers","summary":"Return List Of Active Users"},"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/KycProtectGetCustomerUsersDetailsResponse"}},"schemaId":"components/schemas/KycProtectGetCustomerUsersDetailsResponse"},{"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/~1access~1users~1active/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/KycProtectGetCustomerUsersDetailsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KycProtectGetCustomerUsersDetailsResponse"}}},{"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":"/user-administration/protectgetactivecustomerusers"}],"panels":[]}]},"httpPath":"/access/users/active"},{"label":"Return Logged In User Details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/user-administration/protectgetdetailsofloggedinuser","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/user-administration/protectgetdetailsofloggedinuser","metadata":{"seo":{"title":"Return Logged In User Details","description":"Returns the details of logged in user."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"protectGETDetailsOfLoggedInUser","name":"Return Logged In User Details","isWebhook":false,"pointer":"/paths/~1access~1users~1me/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return Logged In User Details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the details of logged in user."},{"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":"/access/users/me","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","404"],"pointer":"/access/users/me","href":"user-administration/protectgetdetailsofloggedinuser","openApiOperationId":"protectGETDetailsOfLoggedInUser","summary":"Return Logged In User Details"},"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/KycProtectGetMyUserDetailsResponse"}},"schemaId":"components/schemas/KycProtectGetMyUserDetailsResponse"},{"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/~1access~1users~1me/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/KycProtectGetMyUserDetailsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KycProtectGetMyUserDetailsResponse"}}},{"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":"/user-administration/protectgetdetailsofloggedinuser"}],"panels":[]}]},"httpPath":"/access/users/me"}],"content":{"contentType":"group","meta":{"name":"User Administration"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"User Administration","showPageActions":true},{"nodeType":"markdoc","content":"Endpoints for user management."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/access","summary":"Return Subscription Details","prefix":{"name":"get","color":"get"},"badges":[],"link":"/user-administration/subscriptiondetails","deprecated":false},{"title":"/access/users/active","summary":"Return List Of Active Users","prefix":{"name":"get","color":"get"},"badges":[],"link":"/user-administration/protectgetactivecustomerusers","deprecated":false},{"title":"/access/users/me","summary":"Return Logged In User Details","prefix":{"name":"get","color":"get"},"badges":[],"link":"/user-administration/protectgetdetailsofloggedinuser","deprecated":false}]}]}]}]}},{"type":"separator","label":"Check and Decide","content":null},{"type":"group","label":"Instance Management","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/instance-management","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/instance-management","items":[{"label":"Return Instance Configuration","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/instance-management/instanceconfiguration","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/instance-management/instanceconfiguration","metadata":{"seo":{"title":"Return Instance Configuration","description":"Returns instance user has permission to access."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"instanceConfiguration","name":"Return Instance Configuration","isWebhook":false,"pointer":"/paths/~1decisionEngine~1instance~1{guid}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return Instance Configuration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns instance user has permission to access."},{"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":"guid","in":"path","schemaId":"schema_387","description":"Get results by guid.","required":true}],"pointer":"/paths/~1decisionEngine~1instance~1{guid}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"category","in":"query","schemaId":"schema_387","description":"Filters instance by contract category i.e., Bronze, Silver or Gold."}],"pointer":"/paths/~1decisionEngine~1instance~1{guid}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/decisionEngine/instance/{guid}","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"guid","in":"path","required":true,"schemaId":"schema_387"}],"query":[{"name":"category","in":"query","required":false,"schemaId":"schema_387"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/decisionEngine/instance/{guid}","href":"instance-management/instanceconfiguration","openApiOperationId":"instanceConfiguration","summary":"Return Instance Configuration"},"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/CreditsafeGlobalDataReportsCompanyReportExtraSection"}},"schemaId":"components/schemas/CreditsafeGlobalDataReportsCompanyReportExtraSection"},{"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/~1decisionEngine~1instance~1{guid}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CreditsafeGlobalDataReportsCompanyReportExtraSection","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreditsafeGlobalDataReportsCompanyReportExtraSection"}}},{"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":"/instance-management/instanceconfiguration"}],"panels":[]}]},"httpPath":"/decisionEngine/instance/{guid}"},{"label":"Update Instance Configuration","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/instance-management/updateinstanceconfiguration","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/instance-management/updateinstanceconfiguration","metadata":{"seo":{"title":"Update Instance Configuration","description":"Update the instances information.You will need to call the GET /decisionEngine/instance/{guid} endpoint to get the current configuration and then update the fields you want to change."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateInstanceConfiguration","name":"Update Instance Configuration","isWebhook":false,"pointer":"/paths/~1decisionEngine~1instance~1{guid}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Instance Configuration","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":"Update the instances information."},"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":"You will need to call the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /decisionEngine/instance/{guid}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint to get the current configuration and then update the fields you want to change."},"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":"guid","in":"path","schemaId":"schema_387","description":"get results by guid.","required":true}],"pointer":"/paths/~1decisionEngine~1instance~1{guid}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateDecisionEngineInstanceRequestBodyWithExample"}},"schemaId":"components/schemas/UpdateDecisionEngineInstanceRequestBodyWithExample","pointer":"/paths/~1decisionEngine~1instance~1{guid}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/decisionEngine/instance/{guid}","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"guid","in":"path","required":true,"schemaId":"schema_387"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateDecisionEngineInstanceRequestBodyWithExample"}},"responseCodes":["200","400","401","403","404"],"pointer":"/decisionEngine/instance/{guid}","href":"instance-management/updateinstanceconfiguration","openApiOperationId":"updateInstanceConfiguration","summary":"Update Instance Configuration"},"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/UpdateDecisionEngineInstanceRequestBodyWithExample","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateDecisionEngineInstanceRequestBodyWithExample"}},"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/CreditsafeGlobalDataReportsCompanyReportExtraSection"}},"schemaId":"components/schemas/CreditsafeGlobalDataReportsCompanyReportExtraSection"},{"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/~1decisionEngine~1instance~1{guid}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CreditsafeGlobalDataReportsCompanyReportExtraSection","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreditsafeGlobalDataReportsCompanyReportExtraSection"}}},{"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":"/instance-management/updateinstanceconfiguration"}],"panels":[]}]},"httpPath":"/decisionEngine/instance/{guid}"},{"label":"Return All Available Instances","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/instance-management/returnallinstances","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/instance-management/returnallinstances","metadata":{"seo":{"title":"Return All Available Instances","description":"Returns all instances (Decision Trees) a user has permission to access."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"returnAllInstances","name":"Return All Available Instances","isWebhook":false,"pointer":"/paths/~1decisionEngine~1instances/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return All Available Instances","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns all instances (Decision Trees) a user has permission to access."},{"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":"customerId","in":"query","schemaId":"schema_388","description":"The unique identifier of the customer. If used it will return all the Decision Trees associated to that customer."},{"name":"userId","in":"query","schemaId":"schema_388","description":"The unique identifier of the user. If used it will return all the Decision Trees that user has access to."}],"pointer":"/paths/~1decisionEngine~1instances/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/decisionEngine/instances","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[],"query":[{"name":"customerId","in":"query","schemaId":"schema_388"},{"name":"userId","in":"query","schemaId":"schema_388"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/decisionEngine/instances","href":"instance-management/returnallinstances","openApiOperationId":"returnAllInstances","summary":"Return All Available Instances"},"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/GetDecisionEngineInstancesResponse"}},"schemaId":"components/schemas/GetDecisionEngineInstancesResponse"},{"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/~1decisionEngine~1instances/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetDecisionEngineInstancesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetDecisionEngineInstancesResponse"}}},{"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":"/instance-management/returnallinstances"}],"panels":[]}]},"httpPath":"/decisionEngine/instances"}],"content":{"contentType":"group","meta":{"name":"Instance Management"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Instance Management","showPageActions":true},{"nodeType":"markdoc","content":"Endpoints for managing decision engine instances, including retrieval, and updating."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/decisionEngine/instance/{guid}","summary":"Return Instance Configuration","prefix":{"name":"get","color":"get"},"badges":[],"link":"/instance-management/instanceconfiguration","deprecated":false},{"title":"/decisionEngine/instance/{guid}","summary":"Update Instance Configuration","prefix":{"name":"put","color":"put"},"badges":[],"link":"/instance-management/updateinstanceconfiguration","deprecated":false},{"title":"/decisionEngine/instances","summary":"Return All Available Instances","prefix":{"name":"get","color":"get"},"badges":[],"link":"/instance-management/returnallinstances","deprecated":false}]}]}]}]}},{"type":"group","label":"Decision Trees","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/decision-trees","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/decision-trees","items":[{"label":"Return User Data Fields","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/decision-trees/userdatafields","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/decision-trees/userdatafields","metadata":{"seo":{"title":"Return User Data Fields","description":"Returns the user data fields defined for the given decision tree GUID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"userDataFields","name":"Return User Data Fields","isWebhook":false,"pointer":"/paths/~1decisionEngine~1{provenirId}~1userDataFields/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return User Data Fields","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the user data fields defined for the given decision tree GUID."},{"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":"provenirId","in":"path","schemaId":"schema_387","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier of the decision tree, obtained from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/GUID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1decisionEngine~1{provenirId}~1userDataFields/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/decisionEngine/{provenirId}/userDataFields","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"provenirId","in":"path","required":true,"schemaId":"schema_387"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401"],"pointer":"/decisionEngine/{provenirId}/userDataFields","href":"decision-trees/userdatafields","openApiOperationId":"userDataFields","summary":"Return User Data Fields"},"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/ConnectDecisionEngineUserDataFieldsResponse"}},"schemaId":"components/schemas/ConnectDecisionEngineUserDataFieldsResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}},"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}],"pointer":"/paths/~1decisionEngine~1{provenirId}~1userDataFields/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConnectDecisionEngineUserDataFieldsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectDecisionEngineUserDataFieldsResponse"}}},{"code":"400","schemaId":"components/schemas/ConnectErrorResponsesBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}}},{"code":"401","schemaId":"components/schemas/ConnectErrorResponsesInvalidToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/decision-trees/userdatafields"}],"panels":[]}]},"httpPath":"/decisionEngine/{provenirId}/userDataFields"},{"label":"Return Decision Trees","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/decision-trees/decisiontrees","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/decision-trees/decisiontrees","metadata":{"seo":{"title":"Return Decision Trees","description":"Returns all decision trees that the user has permission to access."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"decisionTrees","name":"Return Decision Trees","isWebhook":false,"pointer":"/paths/~1decisionEngine~1GUID/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return Decision Trees","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns all decision trees that the user has permission to access."},{"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":"sortDir","in":"query","schemaId":"schema_389","description":"The direction that you wish to sort results by."},{"name":"type","in":"query","schemaId":"schema_390","description":"Filter the returned decision trees by their associated decision tree type."},{"name":"sortBy","in":"query","schemaId":"schema_391","description":"Sort results by this column."},{"name":"decisionOutcome","in":"query","schemaId":"schema_392","description":"Fetch decision outcome in guid list endpoint."}],"pointer":"/paths/~1decisionEngine~1GUID/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/decisionEngine/GUID","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[],"query":[{"name":"sortDir","in":"query","schemaId":"schema_389"},{"name":"type","in":"query","schemaId":"schema_390"},{"name":"sortBy","in":"query","schemaId":"schema_391"},{"name":"decisionOutcome","in":"query","schemaId":"schema_392"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401"],"pointer":"/decisionEngine/GUID","href":"decision-trees/decisiontrees","openApiOperationId":"decisionTrees","summary":"Return Decision Trees"},"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/ConnectDecisionEngineGUIDListResponse"}},"schemaId":"components/schemas/ConnectDecisionEngineGUIDListResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}},"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}],"pointer":"/paths/~1decisionEngine~1GUID/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConnectDecisionEngineGUIDListResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectDecisionEngineGUIDListResponse"}}},{"code":"400","schemaId":"components/schemas/ConnectErrorResponsesBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}}},{"code":"401","schemaId":"components/schemas/ConnectErrorResponsesInvalidToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/decision-trees/decisiontrees"}],"panels":[]}]},"httpPath":"/decisionEngine/GUID"}],"content":{"contentType":"group","meta":{"name":"Decision Trees"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Decision Trees","showPageActions":true},{"nodeType":"markdoc","content":"Endpoints for accessing and managing pre-configured decision trees used for automated credit decisions."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/decisionEngine/{provenirId}/userDataFields","summary":"Return User Data Fields","prefix":{"name":"get","color":"get"},"badges":[],"link":"/decision-trees/userdatafields","deprecated":false},{"title":"/decisionEngine/GUID","summary":"Return Decision Trees","prefix":{"name":"get","color":"get"},"badges":[],"link":"/decision-trees/decisiontrees","deprecated":false}]}]}]}]}},{"type":"group","label":"Decision Logs","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/decision-logs","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/decision-logs","items":[{"label":"Return Decision History","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/decision-logs/decisionhistory","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/decision-logs/decisionhistory","metadata":{"seo":{"title":"Return Decision History","description":"Returns a log of all previously ran decisions that the user has permission to access, optionally filtered."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"decisionHistory","name":"Return Decision History","isWebhook":false,"pointer":"/paths/~1decisionEngine~1usageLog/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return Decision History","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a log of all previously ran decisions that the user has permission to access, optionally filtered."},{"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":"provenirId","in":"query","schemaId":"schema_393","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter the returned usage log by the GUID for the associated decision trees, obtained from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/GUID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"companyId","in":"query","schemaId":"schema_394","description":"Filter the returned usage log by the Connect ID for the associated companies for each decision."},{"name":"companyName","in":"query","schemaId":"schema_395","description":"Filter the returned usage log by the Company Name for the associated companies for each decision."},{"name":"status","in":"query","schemaId":"schema_396","description":"Filter the returned usage log by the status for each decision."},{"name":"fromDate","in":"query","schemaId":"schema_397","description":"Filter the returned usage log by the date the the decision was run."},{"name":"toDate","in":"query","schemaId":"schema_397","description":"Filter the returned usage log by the date the the decision was run."},{"name":"page","in":"query","schemaId":"schema_398","description":"Starting page number."},{"name":"pageSize","in":"query","schemaId":"schema_388","description":"Specifies the number of items to be displayed per page. Allowed values are between 1 and 100."}],"pointer":"/paths/~1decisionEngine~1usageLog/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/decisionEngine/usageLog","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[],"query":[{"name":"provenirId","in":"query","example":"repoObj_0ed6a4aa_16e17d977e9_07ffb16e17d977e9","schemaId":"schema_393"},{"name":"companyId","in":"query","example":"US001-X-US60521352","schemaId":"schema_394"},{"name":"companyName","in":"query","example":"CREDITSAFE","schemaId":"schema_395"},{"name":"status","in":"query","example":1,"schemaId":"schema_396"},{"name":"fromDate","in":"query","schemaId":"schema_397"},{"name":"toDate","in":"query","schemaId":"schema_397"},{"name":"page","in":"query","schemaId":"schema_398"},{"name":"pageSize","in":"query","schemaId":"schema_388"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401"],"pointer":"/decisionEngine/usageLog","href":"decision-logs/decisionhistory","openApiOperationId":"decisionHistory","summary":"Return Decision 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":"components/schemas/ConnectDecisionEngineUsageLogResponse"}},"schemaId":"components/schemas/ConnectDecisionEngineUsageLogResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}},"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}],"pointer":"/paths/~1decisionEngine~1usageLog/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConnectDecisionEngineUsageLogResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectDecisionEngineUsageLogResponse"}}},{"code":"400","schemaId":"components/schemas/ConnectErrorResponsesBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}}},{"code":"401","schemaId":"components/schemas/ConnectErrorResponsesInvalidToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/decision-logs/decisionhistory"}],"panels":[]}]},"httpPath":"/decisionEngine/usageLog"},{"label":"Return Decision Log","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/decision-logs/getdecisionlog","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/decision-logs/getdecisionlog","metadata":{"seo":{"title":"Return Decision Log","description":"Returns a specified decision log for a previously ran decision."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDecisionLog","name":"Return Decision Log","isWebhook":false,"pointer":"/paths/~1decisionEngine~1usageLog~1{decisionLogId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return Decision Log","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a specified decision log for a previously ran decision."},{"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":"decisionLogId","in":"path","schemaId":"schema_387","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier of the decision log to retrieve, obtained from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/usageLog"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1decisionEngine~1usageLog~1{decisionLogId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/decisionEngine/usageLog/{decisionLogId}","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"decisionLogId","in":"path","required":true,"schemaId":"schema_387"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401"],"pointer":"/decisionEngine/usageLog/{decisionLogId}","href":"decision-logs/getdecisionlog","openApiOperationId":"getDecisionLog","summary":"Return Decision Log"},"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/ConnectDecisionEngineDecisionLogResponse"}},"schemaId":"components/schemas/ConnectDecisionEngineDecisionLogResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}},"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}],"pointer":"/paths/~1decisionEngine~1usageLog~1{decisionLogId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConnectDecisionEngineDecisionLogResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectDecisionEngineDecisionLogResponse"}}},{"code":"400","schemaId":"components/schemas/ConnectErrorResponsesBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}}},{"code":"401","schemaId":"components/schemas/ConnectErrorResponsesInvalidToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/decision-logs/getdecisionlog"}],"panels":[]}]},"httpPath":"/decisionEngine/usageLog/{decisionLogId}"},{"label":"Update Decision Log","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/decision-logs/updatedecisionlog","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/decision-logs/updatedecisionlog","metadata":{"seo":{"title":"Update Decision Log","description":"Updates the status and/or notes for a specified decision."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateDecisionLog","name":"Update Decision Log","isWebhook":false,"pointer":"/paths/~1decisionEngine~1usageLog~1{decisionLogId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Decision Log","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates the status and/or notes for a specified decision."},{"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":"decisionLogId","in":"path","schemaId":"schema_387","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier of the decision log to retrieve, obtained from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/usageLog"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1decisionEngine~1usageLog~1{decisionLogId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ConnectDecisionEngineUpdateDecisionRequest"}},"schemaId":"components/schemas/ConnectDecisionEngineUpdateDecisionRequest","pointer":"/paths/~1decisionEngine~1usageLog~1{decisionLogId}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/decisionEngine/usageLog/{decisionLogId}","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"decisionLogId","in":"path","required":true,"schemaId":"schema_387"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ConnectDecisionEngineUpdateDecisionRequest"}},"responseCodes":["200","400","401"],"pointer":"/decisionEngine/usageLog/{decisionLogId}","href":"decision-logs/updatedecisionlog","openApiOperationId":"updateDecisionLog","summary":"Update Decision Log"},"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/ConnectDecisionEngineUpdateDecisionRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ConnectDecisionEngineUpdateDecisionRequest"}},"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/ConnectDecisionEngineDecisionLogResponse"}},"schemaId":"components/schemas/ConnectDecisionEngineDecisionLogResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}},"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}],"pointer":"/paths/~1decisionEngine~1usageLog~1{decisionLogId}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConnectDecisionEngineDecisionLogResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectDecisionEngineDecisionLogResponse"}}},{"code":"400","schemaId":"components/schemas/ConnectErrorResponsesBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}}},{"code":"401","schemaId":"components/schemas/ConnectErrorResponsesInvalidToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/decision-logs/updatedecisionlog"}],"panels":[]}]},"httpPath":"/decisionEngine/usageLog/{decisionLogId}"}],"content":{"contentType":"group","meta":{"name":"Decision Logs"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Decision Logs","showPageActions":true},{"nodeType":"markdoc","content":"Endpoints for retrieving and managing logs of past decisions."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/decisionEngine/usageLog","summary":"Return Decision History","prefix":{"name":"get","color":"get"},"badges":[],"link":"/decision-logs/decisionhistory","deprecated":false},{"title":"/decisionEngine/usageLog/{decisionLogId}","summary":"Return Decision Log","prefix":{"name":"get","color":"get"},"badges":[],"link":"/decision-logs/getdecisionlog","deprecated":false},{"title":"/decisionEngine/usageLog/{decisionLogId}","summary":"Update Decision Log","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/decision-logs/updatedecisionlog","deprecated":false}]}]}]}]}},{"type":"group","label":"Run Decision","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/run-decision","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/run-decision","items":[{"label":"Run Decision Tree","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/run-decision/rundecisiontree","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/run-decision/rundecisiontree","metadata":{"seo":{"title":"Run Decision Tree","description":"Runs the provided decision tree for the given company, optionally using the data provided in the body of the call."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"runDecisionTree","name":"Run Decision Tree","isWebhook":false,"pointer":"/paths/~1decisionEngine~1{provenirId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Run Decision Tree","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Runs the provided decision tree for the given company, optionally using the data provided in the body of the call."},{"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":"provenirId","in":"path","schemaId":"schema_387","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier of the decision tree to run, obtained from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/GUID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1decisionEngine~1{provenirId}/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"companyId","in":"query","schemaId":"schema_399","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Connect ID for the company that you wish to run the decision tree on. Obtained from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/companies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" search results. A Connect ID is the primary Company identifier that is used to uniquely identify all companies across Creditsafe's Universe and Partner Network."},"children":[]}]}]}],"required":true},{"name":"originationId","in":"query","schemaId":"schema_400","description":"An optional field that will allow text passed through to be stored against the decision. Typically used for internal identifiers (e.g. SalesForce IDs)."}],"pointer":"/paths/~1decisionEngine~1{provenirId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_401"}},"schemaId":"schema_401","pointer":"/paths/~1decisionEngine~1{provenirId}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/decisionEngine/{provenirId}","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"provenirId","in":"path","required":true,"schemaId":"schema_387"}],"query":[{"name":"companyId","in":"query","required":true,"example":"GB-0-03836192","schemaId":"schema_399"},{"name":"originationId","in":"query","required":false,"example":"SFC-1976","schemaId":"schema_400"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_401"}},"responseCodes":["200","400","401"],"pointer":"/decisionEngine/{provenirId}","href":"run-decision/rundecisiontree","openApiOperationId":"runDecisionTree","summary":"Run Decision Tree"},"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_401","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_401"}},"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/ConnectDecisionEngineRunDecisionResponse"}},"schemaId":"components/schemas/ConnectDecisionEngineRunDecisionResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}},"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}],"pointer":"/paths/~1decisionEngine~1{provenirId}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConnectDecisionEngineRunDecisionResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectDecisionEngineRunDecisionResponse"}}},{"code":"400","schemaId":"components/schemas/ConnectErrorResponsesBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}}},{"code":"401","schemaId":"components/schemas/ConnectErrorResponsesInvalidToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/run-decision/rundecisiontree"}],"panels":[]}]},"httpPath":"/decisionEngine/{provenirId}"}],"content":{"contentType":"group","meta":{"name":"Run Decision"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Run Decision","showPageActions":true},{"nodeType":"markdoc","content":"Endpoints for executing decision trees to automate credit decisions."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/decisionEngine/{provenirId}","summary":"Run Decision Tree","prefix":{"name":"post","color":"post"},"badges":[],"link":"/run-decision/rundecisiontree","deprecated":false}]}]}]}]}},{"type":"group","label":"Decision Outcome","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/decision-outcome","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/decision-outcome","items":[{"label":"Return Decision Outcome","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/decision-outcome/decisionoutcome","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/decision-outcome/decisionoutcome","metadata":{"seo":{"title":"Return Decision Outcome","description":"Returns decision outcomes which is set for decision tree."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"decisionOutcome","name":"Return Decision Outcome","isWebhook":false,"pointer":"/paths/~1decisionEngine~1decisionOutcome~1{guid}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return Decision Outcome","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns decision outcomes which is set for decision tree."},{"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":"guid","in":"path","schemaId":"schema_387","description":"get results by guid.","required":true}],"pointer":"/paths/~1decisionEngine~1decisionOutcome~1{guid}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/decisionEngine/decisionOutcome/{guid}","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"guid","in":"path","required":true,"schemaId":"schema_387"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/decisionEngine/decisionOutcome/{guid}","href":"decision-outcome/decisionoutcome","openApiOperationId":"decisionOutcome","summary":"Return Decision Outcome"},"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/GetDecisionEngineDecisionOutcomeResponse"}},"schemaId":"components/schemas/GetDecisionEngineDecisionOutcomeResponse","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_402"},{"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/~1decisionEngine~1decisionOutcome~1{guid}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetDecisionEngineDecisionOutcomeResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetDecisionEngineDecisionOutcomeResponse"}}},{"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":"/decision-outcome/decisionoutcome"}],"panels":[]}]},"httpPath":"/decisionEngine/decisionOutcome/{guid}"},{"label":"Update Decision Outcome","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/decision-outcome/updatedecisionenginedecisionoutcomedetails","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/decision-outcome/updatedecisionenginedecisionoutcomedetails","metadata":{"seo":{"title":"Update Decision Outcome","description":"This allows the user to manually update the decision outcome"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateDecisionEngineDecisionOutcomeDetails","name":"Update Decision Outcome","isWebhook":false,"pointer":"/paths/~1decisionEngine~1decisionOutcome~1{guid}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Decision Outcome","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This allows the user to manually update the decision outcome"},{"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":"guid","in":"path","schemaId":"schema_387","description":"updates decision outcomes by guid.","required":true}],"pointer":"/paths/~1decisionEngine~1decisionOutcome~1{guid}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ConnectDecisionEnginePatchDecisionOutcomeRequest"}},"schemaId":"components/schemas/ConnectDecisionEnginePatchDecisionOutcomeRequest","pointer":"/paths/~1decisionEngine~1decisionOutcome~1{guid}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/decisionEngine/decisionOutcome/{guid}","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"guid","in":"path","required":true,"schemaId":"schema_387"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ConnectDecisionEnginePatchDecisionOutcomeRequest"}},"responseCodes":["200","400","401","403","404"],"pointer":"/decisionEngine/decisionOutcome/{guid}","href":"decision-outcome/updatedecisionenginedecisionoutcomedetails","openApiOperationId":"updateDecisionEngineDecisionOutcomeDetails","summary":"Update Decision Outcome"},"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/ConnectDecisionEnginePatchDecisionOutcomeRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ConnectDecisionEnginePatchDecisionOutcomeRequest"}},"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_403"}},"schemaId":"schema_403"},{"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/~1decisionEngine~1decisionOutcome~1{guid}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_403","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_403"}}},{"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":"/decision-outcome/updatedecisionenginedecisionoutcomedetails"}],"panels":[]}]},"httpPath":"/decisionEngine/decisionOutcome/{guid}"}],"content":{"contentType":"group","meta":{"name":"Decision Outcome"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Decision Outcome","showPageActions":true},{"nodeType":"markdoc","content":"Endpoints for retrieving the outcomes of executed decisions, including detailed results."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/decisionEngine/decisionOutcome/{guid}","summary":"Return Decision Outcome","prefix":{"name":"get","color":"get"},"badges":[],"link":"/decision-outcome/decisionoutcome","deprecated":false},{"title":"/decisionEngine/decisionOutcome/{guid}","summary":"Update Decision Outcome","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/decision-outcome/updatedecisionenginedecisionoutcomedetails","deprecated":false}]}]}]}]}},{"type":"separator","label":"Country Risk Compliance","content":null},{"type":"group","label":"Country Risk","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/country-risk","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/country-risk","items":[{"label":"Return Country Risk Details Of A Given Country","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/country-risk/compliancecountryriskcountrycodeget","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/country-risk/compliancecountryriskcountrycodeget","metadata":{"seo":{"title":"Return Country Risk Details Of A Given Country","description":"Returns country risk details for a given country code, including AML, ESG, sovereign, and supply chain indicators when data is available. Fields that evaluate to null in backend processing may be omitted from the customer response payload."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"complianceCountryRiskCountryCodeGet","name":"Return Country Risk Details Of A Given Country","isWebhook":false,"pointer":"/paths/~1compliance~1countryRisk~1{countryCode}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return Country Risk Details Of A Given Country","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns country risk details for a given country code, including AML, ESG, sovereign, and supply chain indicators when data is available. Fields that evaluate to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in backend processing may be omitted from the customer response payload."},"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":"countryCode","in":"path","schemaId":"schema_387","description":"The code of the country.","required":true}],"pointer":"/paths/~1compliance~1countryRisk~1{countryCode}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/compliance/countryRisk/{countryCode}","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"countryCode","in":"path","required":true,"schemaId":"schema_387"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401"],"pointer":"/compliance/countryRisk/{countryCode}","href":"country-risk/compliancecountryriskcountrycodeget","openApiOperationId":"complianceCountryRiskCountryCodeGet","summary":"Return Country Risk Details Of A Given Country"},"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":"Country risk response for the requested country.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ComplianceCountryRiskResponse","exampleIds":["paths/~1compliance~1countryRisk~1{countryCode}/get/responses/200/content/application~1json/examples/standardResponse"]}},"schemaId":"components/schemas/ComplianceCountryRiskResponse","exampleIds":["paths/~1compliance~1countryRisk~1{countryCode}/get/responses/200/content/application~1json/examples/standardResponse"]},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}},"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}],"pointer":"/paths/~1compliance~1countryRisk~1{countryCode}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ComplianceCountryRiskResponse","exampleIds":["paths/~1compliance~1countryRisk~1{countryCode}/get/responses/200/content/application~1json/examples/standardResponse"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ComplianceCountryRiskResponse","exampleIds":["paths/~1compliance~1countryRisk~1{countryCode}/get/responses/200/content/application~1json/examples/standardResponse"]}}},{"code":"400","schemaId":"components/schemas/ConnectErrorResponsesBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}}},{"code":"401","schemaId":"components/schemas/ConnectErrorResponsesInvalidToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/country-risk/compliancecountryriskcountrycodeget"}],"panels":[]}]},"httpPath":"/compliance/countryRisk/{countryCode}"}],"content":{"contentType":"group","meta":{"name":"Country Risk"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Country Risk","showPageActions":true},{"nodeType":"markdoc","content":"Endpoints for retrieving country risk information."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/compliance/countryRisk/{countryCode}","summary":"Return Country Risk Details Of A Given Country","prefix":{"name":"get","color":"get"},"badges":[],"link":"/country-risk/compliancecountryriskcountrycodeget","deprecated":false}]}]}]}]}},{"type":"separator","label":"Bank Match","content":null},{"type":"group","label":"Company Search","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/company-search","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/company-search","items":[{"label":"Return BBAN Company Search","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/company-search/compliancegetbankmatchbbancompanysearch","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/company-search/compliancegetbankmatchbbancompanysearch","metadata":{"seo":{"title":"Return BBAN Company Search","description":"Gets search for bankmatch BBAN company matching"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"compliancegetbankmatchbbancompanysearch","name":"Return BBAN Company Search","isWebhook":false,"pointer":"/paths/~1compliance~1bankMatch~1BBAN~1company/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return BBAN Company Search","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets search for bankmatch BBAN company matching"},{"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":"country","in":"query","schemaId":"schema_387","description":"An ISO Alpha-2 country code of the company","required":true},{"name":"language","in":"query","schemaId":"schema_404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The language code to specify the desired language of the response. Please use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/BBAN/company/searchCriteria"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint to confirm available languages.   If unsupported language is passed, the system defaults to English ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"bankCountry","in":"query","schemaId":"schema_387","description":"An ISO Alpha-2 country code used to specify the country for company bank matching criteria","required":true},{"name":"regNo","in":"query","schemaId":"schema_387","description":"Registration number of the company for bank matching criteria"},{"name":"bban","in":"query","schemaId":"schema_387","description":"Basic Bank Account Number (BBAN) for bank matching criteria"},{"name":"bic","in":"query","schemaId":"schema_387","description":"Bank Identifier Code (BIC) for BBAN company matching"},{"name":"routingCode","in":"query","schemaId":"schema_387","description":"Routing code for BBAN company matching"}],"pointer":"/paths/~1compliance~1bankMatch~1BBAN~1company/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/compliance/bankMatch/BBAN/company","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[],"query":[{"name":"country","in":"query","required":true,"schemaId":"schema_387"},{"name":"language","in":"query","schemaId":"schema_404"},{"name":"bankCountry","in":"query","required":true,"schemaId":"schema_387"},{"name":"regNo","in":"query","schemaId":"schema_387"},{"name":"bban","in":"query","schemaId":"schema_387"},{"name":"bic","in":"query","schemaId":"schema_387"},{"name":"routingCode","in":"query","schemaId":"schema_387"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","202","400","401","403","404","409","502"],"pointer":"/compliance/bankMatch/BBAN/company","href":"company-search/compliancegetbankmatchbbancompanysearch","openApiOperationId":"compliancegetbankmatchbbancompanysearch","summary":"Return BBAN 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","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BankMatchBBANCompanySearch"}},"schemaId":"components/schemas/BankMatchBBANCompanySearch"},{"code":"202","description":"Accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BankMatchIBANCompanySearchAcceptedResponse"}},"schemaId":"components/schemas/BankMatchIBANCompanySearchAcceptedResponse"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}},"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}},"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"},{"code":"502","description":"Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}],"pointer":"/paths/~1compliance~1bankMatch~1BBAN~1company/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/BankMatchBBANCompanySearch","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BankMatchBBANCompanySearch"}}},{"code":"202","schemaId":"components/schemas/BankMatchIBANCompanySearchAcceptedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BankMatchIBANCompanySearchAcceptedResponse"}}},{"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":"409","schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}}},{"code":"502","schemaId":"components/schemas/ConnectErrorResponsesBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/company-search/compliancegetbankmatchbbancompanysearch"}],"panels":[]}]},"httpPath":"/compliance/bankMatch/BBAN/company"},{"label":"Return BBAN Company Search Criteria","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/company-search/compliancegetbankmatchbbancompanysearchcriteria","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/company-search/compliancegetbankmatchbbancompanysearchcriteria","metadata":{"seo":{"title":"Return BBAN Company Search Criteria","description":"Gets search criteria for bankmatch BBAN company matching"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"compliancegetbankmatchbbancompanysearchcriteria","name":"Return BBAN Company Search Criteria","isWebhook":false,"pointer":"/paths/~1compliance~1bankMatch~1BBAN~1company~1searchCriteria/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return BBAN Company Search Criteria","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets search criteria for bankmatch BBAN company matching"},{"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":"bankCountry","in":"query","schemaId":"schema_387","description":"An ISO Alpha-2 country code used to specify the country for company bank matching criteria","required":true}],"pointer":"/paths/~1compliance~1bankMatch~1BBAN~1company~1searchCriteria/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/compliance/bankMatch/BBAN/company/searchCriteria","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[],"query":[{"name":"bankCountry","in":"query","required":true,"schemaId":"schema_387"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409"],"pointer":"/compliance/bankMatch/BBAN/company/searchCriteria","href":"company-search/compliancegetbankmatchbbancompanysearchcriteria","openApiOperationId":"compliancegetbankmatchbbancompanysearchcriteria","summary":"Return BBAN Company Search Criteria"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BankMatchBBANCompanySearchCriteria"}},"schemaId":"components/schemas/BankMatchBBANCompanySearchCriteria"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}},"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}},"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}],"pointer":"/paths/~1compliance~1bankMatch~1BBAN~1company~1searchCriteria/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/BankMatchBBANCompanySearchCriteria","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BankMatchBBANCompanySearchCriteria"}}},{"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":"409","schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/company-search/compliancegetbankmatchbbancompanysearchcriteria"}],"panels":[]}]},"httpPath":"/compliance/bankMatch/BBAN/company/searchCriteria"},{"label":"Return IBAN Company Search","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/company-search/compliancegetbankmatchibancompanysearch","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/company-search/compliancegetbankmatchibancompanysearch","metadata":{"seo":{"title":"Return IBAN Company Search","description":"Gets search for bankmatch IBAN company matching"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"compliancegetbankmatchibancompanysearch","name":"Return IBAN Company Search","isWebhook":false,"pointer":"/paths/~1compliance~1bankMatch~1IBAN~1company/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return IBAN Company Search","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets search for bankmatch IBAN company matching"},{"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":"country","in":"query","schemaId":"schema_387","description":"An ISO Alpha-2 country code of the company","required":true},{"name":"language","in":"query","schemaId":"schema_404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The language code to specify the desired language of the response. Please use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/IBAN/company/searchCriteria"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint to confirm available languages.   If unsupported language is passed, the system defaults to English ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"bankCountry","in":"query","schemaId":"schema_387","description":"An ISO Alpha-2 country code used to specify the country for company bank matching criteria"},{"name":"regNo","in":"query","schemaId":"schema_387","description":"Company registration number for bank matching criteria"},{"name":"iban","in":"query","schemaId":"schema_387","description":"International Bank Account Number (IBAN) for bank matching criteria"}],"pointer":"/paths/~1compliance~1bankMatch~1IBAN~1company/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/compliance/bankMatch/IBAN/company","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[],"query":[{"name":"country","in":"query","required":true,"schemaId":"schema_387"},{"name":"language","in":"query","schemaId":"schema_404"},{"name":"bankCountry","in":"query","schemaId":"schema_387"},{"name":"regNo","in":"query","schemaId":"schema_387"},{"name":"iban","in":"query","schemaId":"schema_387"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","202","400","401","403","404","409"],"pointer":"/compliance/bankMatch/IBAN/company","href":"company-search/compliancegetbankmatchibancompanysearch","openApiOperationId":"compliancegetbankmatchibancompanysearch","summary":"Return IBAN 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","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BankMatchIBANCompanySearch"}},"schemaId":"components/schemas/BankMatchIBANCompanySearch"},{"code":"202","description":"Accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BankMatchIBANCompanySearchAcceptedResponse"}},"schemaId":"components/schemas/BankMatchIBANCompanySearchAcceptedResponse"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}},"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}},"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}],"pointer":"/paths/~1compliance~1bankMatch~1IBAN~1company/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/BankMatchIBANCompanySearch","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BankMatchIBANCompanySearch"}}},{"code":"202","schemaId":"components/schemas/BankMatchIBANCompanySearchAcceptedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BankMatchIBANCompanySearchAcceptedResponse"}}},{"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":"409","schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/company-search/compliancegetbankmatchibancompanysearch"}],"panels":[]}]},"httpPath":"/compliance/bankMatch/IBAN/company"},{"label":"Return IBAN Company Search Criteria","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/company-search/compliancegetbankmatchibancompanysearchcriteria","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/company-search/compliancegetbankmatchibancompanysearchcriteria","metadata":{"seo":{"title":"Return IBAN Company Search Criteria","description":"Gets search criteria for bankmatch IBAN company matching"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"compliancegetbankmatchibancompanysearchcriteria","name":"Return IBAN Company Search Criteria","isWebhook":false,"pointer":"/paths/~1compliance~1bankMatch~1IBAN~1company~1searchCriteria/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return IBAN Company Search Criteria","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets search criteria for bankmatch IBAN company matching"},{"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":"bankCountry","in":"query","schemaId":"schema_387","description":"An ISO Alpha-2 country code used to specify the country for company bank matching criteria","required":true}],"pointer":"/paths/~1compliance~1bankMatch~1IBAN~1company~1searchCriteria/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/compliance/bankMatch/IBAN/company/searchCriteria","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[],"query":[{"name":"bankCountry","in":"query","required":true,"schemaId":"schema_387"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409"],"pointer":"/compliance/bankMatch/IBAN/company/searchCriteria","href":"company-search/compliancegetbankmatchibancompanysearchcriteria","openApiOperationId":"compliancegetbankmatchibancompanysearchcriteria","summary":"Return IBAN Company Search Criteria"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BankMatchIBANCompanySearchCriteria"}},"schemaId":"components/schemas/BankMatchIBANCompanySearchCriteria"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}},"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}},"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}],"pointer":"/paths/~1compliance~1bankMatch~1IBAN~1company~1searchCriteria/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/BankMatchIBANCompanySearchCriteria","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BankMatchIBANCompanySearchCriteria"}}},{"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":"409","schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/company-search/compliancegetbankmatchibancompanysearchcriteria"}],"panels":[]}]},"httpPath":"/compliance/bankMatch/IBAN/company/searchCriteria"}],"content":{"contentType":"group","meta":{"name":"Company Search"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Company Search","showPageActions":true},{"nodeType":"markdoc","content":"Endpoints for matching company bank account details. Supports both IBAN and BBAN formats for companies."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/compliance/bankMatch/BBAN/company","summary":"Return BBAN Company Search","prefix":{"name":"get","color":"get"},"badges":[],"link":"/company-search/compliancegetbankmatchbbancompanysearch","deprecated":false},{"title":"/compliance/bankMatch/BBAN/company/searchCriteria","summary":"Return BBAN Company Search Criteria","prefix":{"name":"get","color":"get"},"badges":[],"link":"/company-search/compliancegetbankmatchbbancompanysearchcriteria","deprecated":false},{"title":"/compliance/bankMatch/IBAN/company","summary":"Return IBAN Company Search","prefix":{"name":"get","color":"get"},"badges":[],"link":"/company-search/compliancegetbankmatchibancompanysearch","deprecated":false},{"title":"/compliance/bankMatch/IBAN/company/searchCriteria","summary":"Return IBAN Company Search Criteria","prefix":{"name":"get","color":"get"},"badges":[],"link":"/company-search/compliancegetbankmatchibancompanysearchcriteria","deprecated":false}]}]}]}]}},{"type":"group","label":"Person Search","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/person-search","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/person-search","items":[{"label":"Return IBAN Person Search","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/person-search/compliancegetbankmatchibanpersonsearch","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/person-search/compliancegetbankmatchibanpersonsearch","metadata":{"seo":{"title":"Return IBAN Person Search","description":"Gets search for bankmatch IBAN person matching"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"compliancegetbankmatchibanpersonsearch","name":"Return IBAN Person Search","isWebhook":false,"pointer":"/paths/~1compliance~1bankMatch~1IBAN~1person/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return IBAN Person Search","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets search for bankmatch IBAN person matching"},{"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":"language","in":"query","schemaId":"schema_404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The language code to specify the desired language of the response. Please use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/IBAN/person/searchCriteria"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint to confirm available languages.   If unsupported language is passed, the system defaults to English ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"bankCountry","in":"query","schemaId":"schema_387","description":"An ISO Alpha-2 country code used to specify the country for person bank matching criteria","required":true},{"name":"firstName","in":"query","schemaId":"schema_387","description":"First name of the person for bank matching criteria"},{"name":"lastName","in":"query","schemaId":"schema_387","description":"Last name of the person for bank matching criteria"},{"name":"birthDate","in":"query","schemaId":"schema_405","description":"Birth date of the person in the format DD/MM/YYYY for bank matching criteria"},{"name":"iban","in":"query","schemaId":"schema_387","description":"International Bank Account Number (IBAN) for bank matching criteria"}],"pointer":"/paths/~1compliance~1bankMatch~1IBAN~1person/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/compliance/bankMatch/IBAN/person","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[],"query":[{"name":"language","in":"query","schemaId":"schema_404"},{"name":"bankCountry","in":"query","required":true,"schemaId":"schema_387"},{"name":"firstName","in":"query","schemaId":"schema_387"},{"name":"lastName","in":"query","schemaId":"schema_387"},{"name":"birthDate","in":"query","example":"28/04/1978","schemaId":"schema_405"},{"name":"iban","in":"query","schemaId":"schema_387"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","202","400","401","403","404","409"],"pointer":"/compliance/bankMatch/IBAN/person","href":"person-search/compliancegetbankmatchibanpersonsearch","openApiOperationId":"compliancegetbankmatchibanpersonsearch","summary":"Return IBAN Person 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","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BankMatchIBANPersonSearch"}},"schemaId":"components/schemas/BankMatchIBANPersonSearch"},{"code":"202","description":"Accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BankMatchIBANPersonSearchAcceptedResponse"}},"schemaId":"components/schemas/BankMatchIBANPersonSearchAcceptedResponse"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}},"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}},"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}],"pointer":"/paths/~1compliance~1bankMatch~1IBAN~1person/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/BankMatchIBANPersonSearch","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BankMatchIBANPersonSearch"}}},{"code":"202","schemaId":"components/schemas/BankMatchIBANPersonSearchAcceptedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BankMatchIBANPersonSearchAcceptedResponse"}}},{"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":"409","schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/person-search/compliancegetbankmatchibanpersonsearch"}],"panels":[]}]},"httpPath":"/compliance/bankMatch/IBAN/person"},{"label":"Return IBAN Person Search Criteria","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/person-search/compliancegetbankmatchibanpersonsearchcriteria","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/person-search/compliancegetbankmatchibanpersonsearchcriteria","metadata":{"seo":{"title":"Return IBAN Person Search Criteria","description":"Returns the search criteria for bankmatch IBAN person matching"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"compliancegetbankmatchibanpersonsearchcriteria","name":"Return IBAN Person Search Criteria","isWebhook":false,"pointer":"/paths/~1compliance~1bankMatch~1IBAN~1person~1searchCriteria/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return IBAN Person Search Criteria","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the search criteria for bankmatch IBAN person matching"},{"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":"bankCountry","in":"query","schemaId":"schema_387","description":"An ISO Alpha-2 country code used to specify the country for person bank matching criteria","required":true}],"pointer":"/paths/~1compliance~1bankMatch~1IBAN~1person~1searchCriteria/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/compliance/bankMatch/IBAN/person/searchCriteria","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[],"query":[{"name":"bankCountry","in":"query","required":true,"schemaId":"schema_387"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","502"],"pointer":"/compliance/bankMatch/IBAN/person/searchCriteria","href":"person-search/compliancegetbankmatchibanpersonsearchcriteria","openApiOperationId":"compliancegetbankmatchibanpersonsearchcriteria","summary":"Return IBAN Person Search Criteria"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BankMatchIBANPersonSearchCriteria"}},"schemaId":"components/schemas/BankMatchIBANPersonSearchCriteria"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}},"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}},"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"},{"code":"502","description":"Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}],"pointer":"/paths/~1compliance~1bankMatch~1IBAN~1person~1searchCriteria/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/BankMatchIBANPersonSearchCriteria","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BankMatchIBANPersonSearchCriteria"}}},{"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":"409","schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}}},{"code":"502","schemaId":"components/schemas/ConnectErrorResponsesBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/person-search/compliancegetbankmatchibanpersonsearchcriteria"}],"panels":[]}]},"httpPath":"/compliance/bankMatch/IBAN/person/searchCriteria"}],"content":{"contentType":"group","meta":{"name":"Person Search"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Person Search","showPageActions":true},{"nodeType":"markdoc","content":"Endpoints for matching personal bank account details. Supports both IBAN and BBAN formats for individuals."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/compliance/bankMatch/IBAN/person","summary":"Return IBAN Person Search","prefix":{"name":"get","color":"get"},"badges":[],"link":"/person-search/compliancegetbankmatchibanpersonsearch","deprecated":false},{"title":"/compliance/bankMatch/IBAN/person/searchCriteria","summary":"Return IBAN Person Search Criteria","prefix":{"name":"get","color":"get"},"badges":[],"link":"/person-search/compliancegetbankmatchibanpersonsearchcriteria","deprecated":false}]}]}]}]}},{"type":"separator","label":"Credit and Risk","content":null},{"type":"group","label":"Search And Report Schemas/Criteria","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/search-and-report-schemascriteria","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/search-and-report-schemascriteria","items":[{"label":"Return Languages Available For Company Reports For Selected Country","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/search-and-report-schemascriteria/useraccessreportlanguages","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/search-and-report-schemascriteria/useraccessreportlanguages","metadata":{"seo":{"title":"Return Languages Available For Company Reports For Selected Country","description":"Endpoint which returns available languages for a report.   The JSON structure of the report is language invariant, but field content will return in the selected language where available."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"userAccessReportLanguages","name":"Return Languages Available For Company Reports For Selected Country","isWebhook":false,"pointer":"/paths/~1access~1countries~1{countryCode}~1reportLanguages/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return Languages Available For Company Reports For Selected Country","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 which returns available languages for a report.   The JSON structure of the report is language invariant, but field content will return in the selected language where available."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: The availability of field content in a specific language depends on the data source. If certain properties in the report are not available in the chosen language, they will default to English. As a result, only a certain percentage of the report may appear in the selected language."},"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":"countryCode","in":"path","schemaId":"schema_387","description":"Accepts valid iso-2 country code","required":true,"example":"NL"}],"pointer":"/paths/~1access~1countries~1{countryCode}~1reportLanguages/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/access/countries/{countryCode}/reportLanguages","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"countryCode","in":"path","required":true,"example":"NL","schemaId":"schema_387"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/access/countries/{countryCode}/reportLanguages","href":"search-and-report-schemascriteria/useraccessreportlanguages","openApiOperationId":"userAccessReportLanguages","summary":"Return Languages Available For Company Reports For Selected Country"},"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_406"}},"schemaId":"schema_406"},{"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/~1access~1countries~1{countryCode}~1reportLanguages/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_406","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_406"}}},{"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":"/search-and-report-schemascriteria/useraccessreportlanguages"}],"panels":[]}]},"httpPath":"/access/countries/{countryCode}/reportLanguages"},{"label":"Report Schema Structure Per Country","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/search-and-report-schemascriteria/reportschema","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/search-and-report-schemascriteria/reportschema","metadata":{"seo":{"title":"Report Schema Structure Per Country","description":"Returns the Company Report JSON schema of the provided country. Largely redundant as the Company Report 200 response is defined as a superset of all country's JSON schemas and can be used for any country."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"reportSchema","name":"Report Schema Structure Per Country","isWebhook":false,"pointer":"/paths/~1companies~1schema~1{countryCode}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Report Schema Structure Per Country","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the Company Report JSON schema of the provided country. Largely redundant as the Company Report 200 response is defined as a superset of all country's JSON schemas and can be used for any country."},{"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":"countryCode","in":"path","schemaId":"schema_387","description":"ISO2 / Alpha 2 Country Code","required":true}],"pointer":"/paths/~1companies~1schema~1{countryCode}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"section","in":"query","schemaId":"schema_407","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CompanyReportResponse"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the Company Credit Report JSON schema."},"children":[]}]}]}],"required":true},{"name":"template","in":"query","schemaId":"schema_387","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For Templated Company Report JSON Schemas."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Selection of templates can be found here:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"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":[]}]}]}]}]}],"pointer":"/paths/~1companies~1schema~1{countryCode}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/companies/schema/{countryCode}","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"countryCode","in":"path","required":true,"schemaId":"schema_387"}],"query":[{"name":"section","in":"query","required":true,"schemaId":"schema_407"},{"name":"template","in":"query","schemaId":"schema_387"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/companies/schema/{countryCode}","href":"search-and-report-schemascriteria/reportschema","openApiOperationId":"reportSchema","summary":"Report Schema Structure Per Country"},"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/CreditsafeGlobalDataReportsCompanyReportExtraSection"}},"schemaId":"components/schemas/CreditsafeGlobalDataReportsCompanyReportExtraSection"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}},"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}],"pointer":"/paths/~1companies~1schema~1{countryCode}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CreditsafeGlobalDataReportsCompanyReportExtraSection","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreditsafeGlobalDataReportsCompanyReportExtraSection"}}},{"code":"401","schemaId":"components/schemas/ConnectErrorResponsesInvalidToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/search-and-report-schemascriteria/reportschema"}],"panels":[]}]},"httpPath":"/companies/schema/{countryCode}"},{"label":"Company Search Criteria","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/search-and-report-schemascriteria/companysearchcriteria","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/search-and-report-schemascriteria/companysearchcriteria","metadata":{"seo":{"title":"Company Search Criteria","description":"Returns the set of available Company Search parameters/fields for a provided list of countries."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"companySearchCriteria","name":"Company Search Criteria","isWebhook":false,"pointer":"/paths/~1companies~1searchcriteria/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Company Search Criteria","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the set of available Company Search parameters/fields for a provided list of countries."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API requires authentication for access to protected endpoints. Authentication is performed by providing a valid JWT token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"countries","in":"query","schemaId":"schema_387","description":"A comma separated list of ISO/Alpha 2 format country codes, or singular country Code. e.g. US,GB will return the common searchable Company fields in the United States and Great Britain.","required":true}],"pointer":"/paths/~1companies~1searchcriteria/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/companies/searchcriteria","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[],"query":[{"name":"countries","in":"query","required":true,"schemaId":"schema_387"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/companies/searchcriteria","href":"search-and-report-schemascriteria/companysearchcriteria","openApiOperationId":"companySearchCriteria","summary":"Company Search Criteria"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreditsafeGlobalDataSearchCriteriaSchemaCountry"}},"schemaId":"components/schemas/CreditsafeGlobalDataSearchCriteriaSchemaCountry"},{"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~1searchcriteria/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CreditsafeGlobalDataSearchCriteriaSchemaCountry","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreditsafeGlobalDataSearchCriteriaSchemaCountry"}}},{"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":"/search-and-report-schemascriteria/companysearchcriteria"}],"panels":[]}]},"httpPath":"/companies/searchcriteria"},{"label":"People/Director Search Criteria","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/search-and-report-schemascriteria/peopledirectorsearchcriteria","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/search-and-report-schemascriteria/peopledirectorsearchcriteria","metadata":{"seo":{"title":"People/Director Search Criteria","description":"Returns the set of available People Search parameters/fields for a provided list of countries."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"peopleDirectorSearchCriteria","name":"People/Director Search Criteria","isWebhook":false,"pointer":"/paths/~1people~1searchcriteria/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"People/Director Search Criteria","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the set of available People Search parameters/fields for a provided list of countries."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API requires authentication for access to protected endpoints. Authentication is performed by providing a valid JWT token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"countries","in":"query","schemaId":"schema_387","description":"A comma separated list of ISO/Alpha 2 format country codes, or singular country Code. e.g. US,GB will return the common searchable People/Director fields in the United States and Great Britain."}],"pointer":"/paths/~1people~1searchcriteria/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people/searchcriteria","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[],"query":[{"name":"countries","in":"query","schemaId":"schema_387"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/people/searchcriteria","href":"search-and-report-schemascriteria/peopledirectorsearchcriteria","openApiOperationId":"peopleDirectorSearchCriteria","summary":"People/Director Search Criteria"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreditsafeGlobalDataSearchCriteriaSchemaSetDirector"}},"schemaId":"components/schemas/CreditsafeGlobalDataSearchCriteriaSchemaSetDirector"},{"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~1searchcriteria/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CreditsafeGlobalDataSearchCriteriaSchemaSetDirector","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreditsafeGlobalDataSearchCriteriaSchemaSetDirector"}}},{"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":"/search-and-report-schemascriteria/peopledirectorsearchcriteria"}],"panels":[]}]},"httpPath":"/people/searchcriteria"}],"content":{"contentType":"group","meta":{"name":"Search And Report Schemas/Criteria"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search And Report Schemas/Criteria","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":"Endpoints to retrieve the structure of the Company and Director Search Criteria,  Report Schemas, and available Report Languages for a specific country. "},"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":" These endpoints provide the necessary information to validate responses,  understand search parameters, and determine localization options for reports."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/access/countries/{countryCode}/reportLanguages","summary":"Return Languages Available For Company Reports For Selected Country","prefix":{"name":"get","color":"get"},"badges":[],"link":"/search-and-report-schemascriteria/useraccessreportlanguages","deprecated":false},{"title":"/companies/schema/{countryCode}","summary":"Report Schema Structure Per Country","prefix":{"name":"get","color":"get"},"badges":[],"link":"/search-and-report-schemascriteria/reportschema","deprecated":false},{"title":"/companies/searchcriteria","summary":"Company Search Criteria","prefix":{"name":"get","color":"get"},"badges":[],"link":"/search-and-report-schemascriteria/companysearchcriteria","deprecated":false},{"title":"/people/searchcriteria","summary":"People/Director Search Criteria","prefix":{"name":"get","color":"get"},"badges":[],"link":"/search-and-report-schemascriteria/peopledirectorsearchcriteria","deprecated":false}]}]}]}]}},{"type":"group","label":"Companies","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/companies","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/companies","items":[{"label":"Company Search","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/companies/companysearch","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/companies/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_398","description":"Starting page number."},{"name":"pageSize","in":"query","schemaId":"schema_388","description":"Specifies the number of items to be displayed per page. Allowed values are between 1 and 100."},{"name":"countries","in":"query","schemaId":"schema_408","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_409","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_410","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_411","description":"Safe Number - Identifier for Companies in Creditsafe's Home Countries."},{"name":"regNo","in":"query","schemaId":"schema_411","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_411","description":"Company VAT Number"},{"name":"name","in":"query","schemaId":"schema_411","description":"Company Name"},{"name":"tradeName","in":"query","schemaId":"schema_411","description":"Trade Name of the Company, typically used in Countries where Name is not uniquely registered."},{"name":"acronym","in":"query","schemaId":"schema_411","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_412","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_411"},{"name":"street","in":"query","schemaId":"schema_410","description":"Address part identifier - Street of the Company"},{"name":"houseNo","in":"query","schemaId":"schema_411","description":"Address part identifier - House/Building Number of the Company"},{"name":"city","in":"query","schemaId":"schema_411","description":"Address part identifier - City of the Company"},{"name":"postCode","in":"query","schemaId":"schema_411","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_411","description":"Address part identifier - Province/State of the Company"},{"name":"callRef","in":"query","schemaId":"schema_410","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_413"},{"name":"phoneNo","in":"query","schemaId":"schema_414","description":"Provides Array of phone numbers or Null"},{"name":"status","in":"query","schemaId":"schema_415"},{"name":"type","in":"query","schemaId":"schema_416"},{"name":"website","in":"query","schemaId":"schema_411"},{"name":"customData","in":"query","schemaId":"schema_411","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_398"},{"name":"pageSize","in":"query","schemaId":"schema_388"},{"name":"countries","in":"query","required":true,"example":"GB,FR","schemaId":"schema_408"},{"name":"language","in":"query","schemaId":"schema_409"},{"name":"id","in":"query","schemaId":"schema_410"},{"name":"safeNo","in":"query","schemaId":"schema_411"},{"name":"regNo","in":"query","schemaId":"schema_411"},{"name":"vatNo","in":"query","schemaId":"schema_411"},{"name":"name","in":"query","schemaId":"schema_411"},{"name":"tradeName","in":"query","schemaId":"schema_411"},{"name":"acronym","in":"query","schemaId":"schema_411"},{"name":"exact","in":"query","schemaId":"schema_412"},{"name":"address","in":"query","schemaId":"schema_411"},{"name":"street","in":"query","schemaId":"schema_410"},{"name":"houseNo","in":"query","schemaId":"schema_411"},{"name":"city","in":"query","schemaId":"schema_411"},{"name":"postCode","in":"query","schemaId":"schema_411"},{"name":"province","in":"query","schemaId":"schema_411"},{"name":"callRef","in":"query","schemaId":"schema_410"},{"name":"officeType","in":"query","schemaId":"schema_413"},{"name":"phoneNo","in":"query","schemaId":"schema_414"},{"name":"status","in":"query","schemaId":"schema_415"},{"name":"type","in":"query","schemaId":"components/schemas/CreditsafeGlobalDataCompanyType"},{"name":"website","in":"query","schemaId":"schema_411"},{"name":"customData","in":"query","schemaId":"schema_411"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/companies","href":"companies/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":"/companies/companysearch"}],"panels":[]}]},"httpPath":"/companies"},{"label":"Company Credit Report","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/companies/companycreditreport","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/companies/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.The response properties listed for this endpoint represent the core global company fields.  For country-specific fields and a complete list of all possible properties for a given country,  use the Report Schema endpoint.  Not all properties will be returned in every response—fields with no value are omitted by design.  In OpenAPI, properties not listed as required are optional."}},"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":[]},{"$$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":"The response properties listed for this endpoint represent the core global company fields.  For country-specific fields and a complete list of all possible properties for a given country,  use the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://doc.creditsafe.com/connect-apis-catalog/product-catalog/creditrisk/creditandrisk/search-and-report-schemascriteria/reportschema"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Report Schema endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":".  Not all properties will be returned in every response—fields with no value are omitted by design. "},"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":" In OpenAPI, properties not listed as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"required"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are optional."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://doc.creditsafe.com/connect-apis-catalog/product-catalog/creditrisk/documentation/companies/companies"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Companies help documentation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API requires authentication for access to protected endpoints. Authentication is performed by providing a valid JWT token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"connectId","in":"path","schemaId":"schema_387","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_417","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_418","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_392","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_411","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_410","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_419","description":"Specifies the desired response format."}],"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_387"}],"query":[{"name":"language","in":"query","schemaId":"schema_417"},{"name":"template","in":"query","schemaId":"schema_418"},{"name":"includeIndicators","in":"query","schemaId":"schema_392"},{"name":"customData","in":"query","schemaId":"schema_411"},{"name":"callRef","in":"query","required":false,"schemaId":"schema_410"}],"querystring":[],"header":[{"name":"Accept","in":"header","required":false,"example":"application/pdf","schemaId":"schema_419"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/companies/{connectId}","href":"companies/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":"/companies/companycreditreport"}],"panels":[]}]},"httpPath":"/companies/{connectId}"},{"label":"Confidence Match Search","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/companies/confidencematchsearch","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/companies/confidencematchsearch","metadata":{"seo":{"title":"Confidence Match Search","description":"Supply all company search criteria to find potential company matches ranked by a single score.   - Interpreting confidence match scores."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"confidenceMatchSearch","name":"Confidence Match Search","isWebhook":false,"pointer":"/paths/~1companies~1match/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Confidence Match 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":"Supply all company search criteria to find potential company matches ranked by a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"single score"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":".   - "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://creditsafe.freshdesk.com/en/support/solutions/articles/7000059769-interpreting-confidence-match-scores","target":"_blank","rel":"noopener noreferrer"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Interpreting confidence match scores"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: This endpoint does not support pagination. Any pagination-related query parameters sent by the client will be ignored and will not affect the 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":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"country","in":"query","schemaId":"schema_387","description":"Iso-2 country code","required":true,"example":"GB"},{"name":"matchThreshold","in":"query","schemaId":"schema_388","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Minimum threshold value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"893"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", maximum threshold value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"999"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true,"example":905},{"name":"regNo","in":"query","schemaId":"schema_411","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_411","description":"Company VAT Number"},{"name":"name","in":"query","schemaId":"schema_411","description":"Company Name","required":true},{"name":"street","in":"query","schemaId":"schema_410","description":"Address part identifier - Street of the Company"},{"name":"houseNo","in":"query","schemaId":"schema_411","description":"Address part identifier - House/Building Number of the Company"},{"name":"city","in":"query","schemaId":"schema_411","description":"Address part identifier - City of the Company"},{"name":"postCode","in":"query","schemaId":"schema_411","description":"Address part identifier - Postcode/Zip Code of the Company."},{"name":"province","in":"query","schemaId":"schema_411","description":"Address part identifier - Province of the Company"},{"name":"phoneNo","in":"query","schemaId":"schema_411"},{"name":"reference1","in":"query","schemaId":"schema_387","description":"Customer supplied free text reference 1 of 3","example":"free text 1"},{"name":"reference2","in":"query","schemaId":"schema_387","description":"Customer supplied free text reference 2 of 3","example":"free text 2"},{"name":"reference3","in":"query","schemaId":"schema_387","description":"Customer supplied free text reference 3 of 3","example":"free text 3"},{"name":"callRef","in":"query","schemaId":"schema_410","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~1match/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/companies/match","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[],"query":[{"name":"country","in":"query","required":true,"example":"GB","schemaId":"schema_387"},{"name":"matchThreshold","in":"query","required":true,"example":905,"schemaId":"schema_388"},{"name":"regNo","in":"query","schemaId":"schema_411"},{"name":"vatNo","in":"query","schemaId":"schema_411"},{"name":"name","in":"query","required":true,"schemaId":"schema_411"},{"name":"street","in":"query","schemaId":"schema_410"},{"name":"houseNo","in":"query","schemaId":"schema_411"},{"name":"city","in":"query","schemaId":"schema_411"},{"name":"postCode","in":"query","schemaId":"schema_411"},{"name":"province","in":"query","schemaId":"schema_411"},{"name":"phoneNo","in":"query","schemaId":"schema_411"},{"name":"reference1","in":"query","example":"free text 1","schemaId":"schema_387"},{"name":"reference2","in":"query","example":"free text 2","schemaId":"schema_387"},{"name":"reference3","in":"query","example":"free text 3","schemaId":"schema_387"},{"name":"callRef","in":"query","schemaId":"schema_410"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/companies/match","href":"companies/confidencematchsearch","openApiOperationId":"confidenceMatchSearch","summary":"Confidence Match 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_420"}},"schemaId":"schema_420"},{"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~1match/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_420","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_420"}}},{"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":"/companies/confidencematchsearch"}],"panels":[]}]},"httpPath":"/companies/match"}],"content":{"contentType":"group","meta":{"name":"Companies"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Companies","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":"Endpoints to search for Companies in the Creditsafe Global Company Database. Companies are uniquely identified by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"connectId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the identifier used to order a Company Credit Report. The Company Credit Report is a JSON object comprising of key business and financial data points such as Credit Score & Limit, Industry Code, Directors, Balance Sheet and Negative Information. A full list of Company data points can be found in the Data Matrix, in the help resources. "},"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":"link","inline":true,"attributes":{"href":"https://doc.creditsafe.com/connect-apis-catalog/product-catalog/creditrisk/creditandrisk/companies/companycreditreport"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order a Company Credit Report"},"children":[]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/companies","summary":"Company Search","prefix":{"name":"get","color":"get"},"badges":[],"link":"/companies/companysearch","deprecated":false},{"title":"/companies/{connectId}","summary":"Company Credit Report","prefix":{"name":"get","color":"get"},"badges":[],"link":"/companies/companycreditreport","deprecated":false},{"title":"/companies/match","summary":"Confidence Match Search","prefix":{"name":"get","color":"get"},"badges":[],"link":"/companies/confidencematchsearch","deprecated":false}]}]}]}]}},{"type":"group","label":"People/Directors","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/peopledirectors","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/peopledirectors","items":[{"label":"Director Search","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/peopledirectors/directorssearch","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/peopledirectors/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_398","description":"Starting page number."},{"name":"pageSize","in":"query","schemaId":"schema_388","description":"Specifies the number of items to be displayed per page. Allowed values are between 1 and 100."},{"name":"countries","in":"query","schemaId":"schema_408","description":"comma-separated list of iso-2 country codes","required":true,"example":"GB,FR"},{"name":"peopleId","in":"query","schemaId":"schema_387","description":"Person/Director Identifier - used to order a Director Report."},{"name":"firstName","in":"query","schemaId":"schema_387","description":"Person's First Name."},{"name":"lastName","in":"query","schemaId":"schema_387","description":"Person's Last Name"},{"name":"localDirectorNumber","in":"query","schemaId":"schema_411","description":"Local Identifier of the Director, the PNR in GB."},{"name":"dateOfBirth","in":"query","schemaId":"schema_387","description":"Person DOB - provide YYYY-MM-DD or YYYY-MM format."},{"name":"callRef","in":"query","schemaId":"schema_411","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_398"},{"name":"pageSize","in":"query","schemaId":"schema_388"},{"name":"countries","in":"query","required":true,"example":"GB,FR","schemaId":"schema_408"},{"name":"peopleId","in":"query","schemaId":"schema_387"},{"name":"firstName","in":"query","schemaId":"schema_387"},{"name":"lastName","in":"query","schemaId":"schema_387"},{"name":"localDirectorNumber","in":"query","schemaId":"schema_411"},{"name":"dateOfBirth","in":"query","schemaId":"schema_387"},{"name":"callRef","in":"query","schemaId":"schema_411"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/people","href":"peopledirectors/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_421"}},"schemaId":"schema_421"},{"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_421","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_421"}}},{"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":"/peopledirectors/directorssearch"}],"panels":[]}]},"httpPath":"/people"},{"label":"Director Report","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/peopledirectors/directorreport","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/peopledirectors/directorreport","metadata":{"seo":{"title":"Director Report","description":"Returns a report from the ID supplied to the search."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"directorReport","name":"Director Report","isWebhook":false,"pointer":"/paths/~1people~1{peopleId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Director Report","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a report from the ID supplied to the search."},{"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":"peopleId","in":"path","schemaId":"schema_422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier of the Person/Director required to order their Director Report. Obtained from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/people"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" search results."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1people~1{peopleId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"language","in":"query","schemaId":"schema_423","description":"Report Language - The JSON structure of the Report is language invariant, but field content will return as the given language, where available."},{"name":"callRef","in":"query","schemaId":"schema_387","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~1{peopleId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people/{peopleId}","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"peopleId","in":"path","required":true,"schemaId":"schema_422"}],"query":[{"name":"language","in":"query","schemaId":"schema_423"},{"name":"callRef","in":"query","schemaId":"schema_387"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/people/{peopleId}","href":"peopledirectors/directorreport","openApiOperationId":"directorReport","summary":"Director Report"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreditsafeGlobalDataReportsDirectorsDirectorReportResponse"}},"schemaId":"components/schemas/CreditsafeGlobalDataReportsDirectorsDirectorReportResponse"},{"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~1{peopleId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CreditsafeGlobalDataReportsDirectorsDirectorReportResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreditsafeGlobalDataReportsDirectorsDirectorReportResponse"}}},{"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":"/peopledirectors/directorreport"}],"panels":[]}]},"httpPath":"/people/{peopleId}"}],"content":{"contentType":"group","meta":{"name":"People/Directors"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"People/Directors","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":"Endpoints to find People/Directors and order Director Reports. A Director Report will contain a person's registered information and Active & Previous Directorships, where available. This endpoint is not advised to get a list of directors for a specific Company. Instead, order a Company Credit Report using the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://doc.creditsafe.com/connect-apis-catalog/product-catalog/creditrisk/creditandrisk/companies/companycreditreport"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Companies Report Endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"directors"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section in the report response."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/people","summary":"Director Search","prefix":{"name":"get","color":"get"},"badges":[],"link":"/peopledirectors/directorssearch","deprecated":false},{"title":"/people/{peopleId}","summary":"Director Report","prefix":{"name":"get","color":"get"},"badges":[],"link":"/peopledirectors/directorreport","deprecated":false}]}]}]}]}},{"type":"group","label":"GB Consumers and AML","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/gb-consumers-and-aml","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/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/connect-api-full/connectapi/gb-consumers-and-aml/submitsagbconsumeroramlsearch","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/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_424"}},"schemaId":"schema_424","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_424"}},"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_424","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_424"}},"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_425"}},"schemaId":"schema_425"},{"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_425","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_425"}}},{"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/connect-api-full/connectapi/gb-consumers-and-aml/resolvesapicklistagainstagivenuniqueid","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/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_387","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_426"}},"schemaId":"schema_426","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_387"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_426"}},"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_426","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_426"}},"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/connect-api-full/connectapi/gb-consumers-and-aml/getidentitysearchhistory","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/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_427","description":"The 1-indexed page number to fetch"},{"name":"pageSize","in":"query","schemaId":"schema_427","description":"The page size number to fetch"},{"name":"IncludeCustomer","in":"query","schemaId":"schema_428","description":"If true, returns all results for this customer. Valid for senior users only."},{"name":"Products","in":"query","schemaId":"schema_429","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_430","description":"The earliest date to include"},{"name":"DateTo","in":"query","schemaId":"schema_430","description":"The latest date to include"},{"name":"Keyword","in":"query","schemaId":"schema_411","description":"Include this string"},{"name":"Result","in":"query","schemaId":"schema_411","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_427"},{"name":"pageSize","in":"query","schemaId":"schema_427"},{"name":"IncludeCustomer","in":"query","schemaId":"schema_428"},{"name":"Products","in":"query","schemaId":"schema_429"},{"name":"DateFrom","in":"query","schemaId":"schema_430"},{"name":"DateTo","in":"query","schemaId":"schema_430"},{"name":"Keyword","in":"query","schemaId":"schema_411"},{"name":"Result","in":"query","schemaId":"schema_411"}],"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/connect-api-full/connectapi/gb-consumers-and-aml/retrievesaprioridentitysearchresult","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/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_387","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_387"}],"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/connect-api-full/connectapi/gb-consumers-and-aml/retrievesaprioridentitysearchesinput","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/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_387","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_387"}],"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/connect-api-full/connectapi/gb-consumers-and-aml/setsthereferenceforanexistinghistoryitem","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/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_387","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_387"}},"schemaId":"schema_387","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_387"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_387"}},"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_387","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_387"}},"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_387"}},"schemaId":"schema_387"},{"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_387","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_387"}}},{"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/connect-api-full/connectapi/gb-consumers-and-aml/revalidateagivenidentitysearchwithadditionaldocuments","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/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_387","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_387"}],"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/connect-api-full/connectapi/gb-consumers-and-aml/getidentitysearchreasons","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/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":"Images","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/images","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/images","items":[{"label":"Company Image","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/images/companyimage","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/images/companyimage","metadata":{"seo":{"title":"Company Image","description":"Endpoint to order an Image Document by Image ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"companyImage","name":"Company Image","isWebhook":false,"pointer":"/paths/~1images~1{imageId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Company Image","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Endpoint to order an Image Document by Image 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":"imageId","in":"path","schemaId":"schema_387","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Image ID retrieved from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"images/companies"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1images~1{imageId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/images/{imageId}","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"imageId","in":"path","required":true,"schemaId":"schema_387"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/images/{imageId}","href":"images/companyimage","openApiOperationId":"companyImage","summary":"Company Image"},"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":"Image object as a binary stream.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreditsafeFreshInvestigationGlobalDataCoreAttachmentBinaryAttachment"}},"schemaId":"components/schemas/CreditsafeFreshInvestigationGlobalDataCoreAttachmentBinaryAttachment"},{"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/~1images~1{imageId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CreditsafeFreshInvestigationGlobalDataCoreAttachmentBinaryAttachment","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreditsafeFreshInvestigationGlobalDataCoreAttachmentBinaryAttachment"}}},{"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":"/images/companyimage"}],"panels":[]}]},"httpPath":"/images/{imageId}"},{"label":"Company Image Documents","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/images/companyimagedocuments","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/images/companyimagedocuments","metadata":{"seo":{"title":"Company Image Documents","description":"Returns the available Images for a given Company connectId."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"companyImageDocuments","name":"Company Image Documents","isWebhook":false,"pointer":"/paths/~1images~1companies/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Company Image Documents","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the available Images for a given Company connectId."},{"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_398","description":"Starting page number."},{"name":"pageSize","in":"query","schemaId":"schema_388","description":"Specifies the number of items to be displayed per page. Allowed values are between 1 and 100."},{"name":"id","in":"query","schemaId":"schema_387","description":"The company's connectId."}],"pointer":"/paths/~1images~1companies/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/images/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_398"},{"name":"pageSize","in":"query","schemaId":"schema_388"},{"name":"id","in":"query","schemaId":"schema_387"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/images/companies","href":"images/companyimagedocuments","openApiOperationId":"companyImageDocuments","summary":"Company Image 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"}],"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/ConnectImagesCompanyImages"}},"schemaId":"components/schemas/ConnectImagesCompanyImages"},{"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/~1images~1companies/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConnectImagesCompanyImages","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectImagesCompanyImages"}}},{"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":"/images/companyimagedocuments"}],"panels":[]}]},"httpPath":"/images/companies"},{"label":"Image Document Category Types","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/images/imagedocumentcategorytypes","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/images/imagedocumentcategorytypes","metadata":{"seo":{"title":"Image Document Category Types","description":"Lists available Image Document formats, types and languages per country."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"imageDocumentCategoryTypes","name":"Image Document Category Types","isWebhook":false,"pointer":"/paths/~1images~1companies~1types/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Image Document Category Types","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists available Image Document formats, types and languages per country."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API requires authentication for access to protected endpoints. Authentication is performed by providing a valid JWT token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"countries","in":"query","schemaId":"schema_387","description":"Filter Images by country."}],"pointer":"/paths/~1images~1companies~1types/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/images/companies/types","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[],"query":[{"name":"countries","in":"query","schemaId":"schema_387"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/images/companies/types","href":"images/imagedocumentcategorytypes","openApiOperationId":"imageDocumentCategoryTypes","summary":"Image Document Category Types"},"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/ConnectImagesCompanyImageTypes"}},"schemaId":"components/schemas/ConnectImagesCompanyImageTypes"},{"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/~1images~1companies~1types/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConnectImagesCompanyImageTypes","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectImagesCompanyImageTypes"}}},{"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":"/images/imagedocumentcategorytypes"}],"panels":[]}]},"httpPath":"/images/companies/types"}],"content":{"contentType":"group","meta":{"name":"Images"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Images","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":"Endpoints to order official Company Image/Filing Documents from"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"source. Company Filings such as Annual Account Statements, Annual Returns,"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Liquidations and Changes of Registered Information can be downloaded as"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PDFs, and are typically used as a resource in extended company"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"auditing/compliance. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/images/{imageId}","summary":"Company Image","prefix":{"name":"get","color":"get"},"badges":[],"link":"/images/companyimage","deprecated":false},{"title":"/images/companies","summary":"Company Image Documents","prefix":{"name":"get","color":"get"},"badges":[],"link":"/images/companyimagedocuments","deprecated":false},{"title":"/images/companies/types","summary":"Image Document Category Types","prefix":{"name":"get","color":"get"},"badges":[],"link":"/images/imagedocumentcategorytypes","deprecated":false}]}]}]}]}},{"type":"group","label":"Fresh Investigations","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/fresh-investigations","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/fresh-investigations","items":[{"label":"Create Fresh Investigation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/fresh-investigations/createfreshinvestigation","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/fresh-investigations/createfreshinvestigation","metadata":{"seo":{"title":"Create Fresh Investigation","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":"createFreshInvestigation","name":"Create Fresh Investigation","isWebhook":false,"pointer":"/paths/~1freshinvestigations/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Fresh Investigation","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":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ConnectFreshInvCreateInvestigation"}},"schemaId":"components/schemas/ConnectFreshInvCreateInvestigation","pointer":"/paths/~1freshinvestigations/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/freshinvestigations","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/ConnectFreshInvCreateInvestigation"}},"responseCodes":["200","400","401","403","404"],"pointer":"/freshinvestigations","href":"fresh-investigations/createfreshinvestigation","openApiOperationId":"createFreshInvestigation","summary":"Create Fresh Investigation"},"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/ConnectFreshInvCreateInvestigation","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ConnectFreshInvCreateInvestigation"}},"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/ConnectFreshInvInvestigationConfirmed"}},"schemaId":"components/schemas/ConnectFreshInvInvestigationConfirmed"},{"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/~1freshinvestigations/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConnectFreshInvInvestigationConfirmed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectFreshInvInvestigationConfirmed"}}},{"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":"/fresh-investigations/createfreshinvestigation"}],"panels":[]}]},"httpPath":"/freshinvestigations"},{"label":"Get Fresh Investigations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/fresh-investigations/getfreshinvestigations","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/fresh-investigations/getfreshinvestigations","metadata":{"seo":{"title":"Get Fresh Investigations","description":"Returns a list of your submitted Fresh Investigation Orders."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getFreshInvestigations","name":"Get Fresh Investigations","isWebhook":false,"pointer":"/paths/~1freshinvestigations/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Fresh Investigations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a list of your submitted Fresh Investigation Orders."},{"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_398","description":"Starting page number."},{"name":"pageSize","in":"query","schemaId":"schema_388","description":"Specifies the number of items to be displayed per page. Allowed values are between 1 and 100."},{"name":"transactionId","in":"query","schemaId":"schema_387","description":"Fresh Investigation Identifier used internally and with our data partners."},{"name":"reportCreatedAfter","in":"query","schemaId":"schema_387","description":"Returns Fresh Investigations processed after this date","example":"2020-01-01T11:23:56Z"},{"name":"reportCreatedBefore","in":"query","schemaId":"schema_387","description":"Returns ordered Fresh Investigations that were processed before this date","example":"2020-01-01T11:23:56Z"},{"name":"createdBefore","in":"query","schemaId":"schema_387","description":"Returns Fresh Investigations created before this date"},{"name":"createdSince","in":"query","schemaId":"schema_387","description":"Returns ordered Fresh Investigations created after this date"},{"name":"lookUpOrderBy","in":"query","schemaId":"schema_431","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use to search for your Fresh Investigations by either the returned Company Details in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"freshInvestigations/{orderId}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint or your supplied Search Criteria in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/freshInvestigations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint"},"children":[]}]}]}]},{"name":"companyDetailsCountry","in":"query","schemaId":"schema_387","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Looks for your returned Fresh Investigations where the returned Company Country is named this. Use with lookUpOrderBy=CompanyDetails"},"children":[]}]}]}]},{"name":"companyDetailsName","in":"query","schemaId":"schema_387","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Looks for your returned Fresh Investigations where the returned Company Name is named this. Use with lookUpOrderBy=CompanyDetails"},"children":[]}]}]}]},{"name":"searchCriteriaCountry","in":"query","schemaId":"schema_387","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Looks for your returned Fresh Investigations where your submitted Search Criteria Company Country is this. Use with lookUpOrderBy=searchCriteria"},"children":[]}]}]}]},{"name":"searchCriteriaName","in":"query","schemaId":"schema_387","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Looks for your Fresh Investigations where your submitted Search Criteria Company Name is this. Use with lookUpOrderBy=searchCriteria"},"children":[]}]}]}]},{"name":"sortBy","in":"query","schemaId":"schema_432","description":"Sorts  returned Fresh Investigations by this field"},{"name":"sortDir","in":"query","schemaId":"schema_389","description":"The direction that you wish to sort results by."}],"pointer":"/paths/~1freshinvestigations/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/freshinvestigations","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_398"},{"name":"pageSize","in":"query","schemaId":"schema_388"},{"name":"transactionId","in":"query","schemaId":"schema_387"},{"name":"reportCreatedAfter","in":"query","example":"2020-01-01T11:23:56Z","schemaId":"schema_387"},{"name":"reportCreatedBefore","in":"query","example":"2020-01-01T11:23:56Z","schemaId":"schema_387"},{"name":"createdBefore","in":"query","schemaId":"schema_387"},{"name":"createdSince","in":"query","schemaId":"schema_387"},{"name":"lookUpOrderBy","in":"query","schemaId":"schema_431"},{"name":"companyDetailsCountry","in":"query","schemaId":"schema_387"},{"name":"companyDetailsName","in":"query","schemaId":"schema_387"},{"name":"searchCriteriaCountry","in":"query","schemaId":"schema_387"},{"name":"searchCriteriaName","in":"query","schemaId":"schema_387"},{"name":"sortBy","in":"query","schemaId":"schema_432"},{"name":"sortDir","in":"query","schemaId":"schema_389"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/freshinvestigations","href":"fresh-investigations/getfreshinvestigations","openApiOperationId":"getFreshInvestigations","summary":"Get Fresh Investigations"},"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/ConnectFreshInvListInvestigations"}},"schemaId":"components/schemas/ConnectFreshInvListInvestigations"},{"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/~1freshinvestigations/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConnectFreshInvListInvestigations","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectFreshInvListInvestigations"}}},{"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":"/fresh-investigations/getfreshinvestigations"}],"panels":[]}]},"httpPath":"/freshinvestigations"},{"label":"Retrieve FreshInvestigation Order","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/fresh-investigations/retrievefreshinvestigationorder","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/fresh-investigations/retrievefreshinvestigationorder","metadata":{"seo":{"title":"Retrieve FreshInvestigation Order","description":"Returns a specific Fresh Investigation order."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieveFreshInvestigationOrder","name":"Retrieve FreshInvestigation Order","isWebhook":false,"pointer":"/paths/~1freshinvestigations~1{orderId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve FreshInvestigation Order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a specific Fresh Investigation order."},{"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":"orderId","in":"path","schemaId":"schema_387","required":true}],"pointer":"/paths/~1freshinvestigations~1{orderId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"sections","in":"query","schemaId":"schema_387","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify a value to return a single section, or multiple-comma separated sections of the completed Fresh Investigation. Leave null to return all sections. Available sections; - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"companyIdentification"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"creditScore"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contactInformation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"directors"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"otherInformation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"groupStructure"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"extendedGroupStructure"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"financialStatements"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"negativeInformation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"additionalInformation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"directorships"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"localFinancialStatements"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentData"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"companySummary"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"alternateSummary"},"children":[]}]}]}],"example":"companyIdentification,creditScore"},{"name":"comments","in":"query","schemaId":"schema_433","description":"Selects number of comments which should be returned with the order details."}],"pointer":"/paths/~1freshinvestigations~1{orderId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/freshinvestigations/{orderId}","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"orderId","in":"path","required":true,"schemaId":"schema_387"}],"query":[{"name":"sections","in":"query","example":"companyIdentification,creditScore","schemaId":"schema_387"},{"name":"comments","in":"query","schemaId":"schema_433"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/freshinvestigations/{orderId}","href":"fresh-investigations/retrievefreshinvestigationorder","openApiOperationId":"retrieveFreshInvestigationOrder","summary":"Retrieve FreshInvestigation Order"},"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":"Returns a specific Fresh Investigation Order. For completed orders this will contain the Investigation content as Report Sections.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectFreshInvCompletedInvestigation"}},"schemaId":"components/schemas/ConnectFreshInvCompletedInvestigation"},{"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/~1freshinvestigations~1{orderId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConnectFreshInvCompletedInvestigation","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectFreshInvCompletedInvestigation"}}},{"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":"/fresh-investigations/retrievefreshinvestigationorder"}],"panels":[]}]},"httpPath":"/freshinvestigations/{orderId}"},{"label":"Delete Fresh Investigations","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/fresh-investigations/deletefreshinvestigations","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/fresh-investigations/deletefreshinvestigations","metadata":{"seo":{"title":"Delete Fresh Investigations","description":"Deletes specified investigations."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteFreshInvestigations","name":"Delete Fresh Investigations","isWebhook":false,"pointer":"/paths/~1freshinvestigations~1{orderId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Fresh Investigations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes specified investigations."},{"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":"orderId","in":"path","schemaId":"schema_387","description":"Investigation id.","required":true}],"pointer":"/paths/~1freshinvestigations~1{orderId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/freshinvestigations/{orderId}","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"orderId","in":"path","required":true,"schemaId":"schema_387"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/freshinvestigations/{orderId}","href":"fresh-investigations/deletefreshinvestigations","openApiOperationId":"deleteFreshInvestigations","summary":"Delete Fresh Investigations"},"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/DeleteFreshInvetigationsByOrderId"}},"schemaId":"components/schemas/DeleteFreshInvetigationsByOrderId"},{"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/~1freshinvestigations~1{orderId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/DeleteFreshInvetigationsByOrderId","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DeleteFreshInvetigationsByOrderId"}}},{"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":"/fresh-investigations/deletefreshinvestigations"}],"panels":[]}]},"httpPath":"/freshinvestigations/{orderId}"},{"label":"Update FreshInvestigation Report Content","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/fresh-investigations/updatefreshinvestigationreportcontent","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/fresh-investigations/updatefreshinvestigationreportcontent","metadata":{"seo":{"title":"Update FreshInvestigation Report Content","description":"Update the Fresh Investigation Report data for a specific order, after the order has a status of delivered."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateFreshInvestigationReportContent","name":"Update FreshInvestigation Report Content","isWebhook":false,"pointer":"/paths/~1freshinvestigations~1{orderId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update FreshInvestigation Report Content","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update the Fresh Investigation Report data for a specific order, after the order has a status of delivered."},{"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":"orderId","in":"path","schemaId":"schema_387","description":"Fresh investigation orderId","required":true}],"pointer":"/paths/~1freshinvestigations~1{orderId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ConnectUpdateFreshInvestigation"}},"schemaId":"components/schemas/ConnectUpdateFreshInvestigation","pointer":"/paths/~1freshinvestigations~1{orderId}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/freshinvestigations/{orderId}","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"orderId","in":"path","required":true,"schemaId":"schema_387"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ConnectUpdateFreshInvestigation"}},"responseCodes":["200","400","401","403","404"],"pointer":"/freshinvestigations/{orderId}","href":"fresh-investigations/updatefreshinvestigationreportcontent","openApiOperationId":"updateFreshInvestigationReportContent","summary":"Update FreshInvestigation Report Content"},"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/ConnectUpdateFreshInvestigation","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ConnectUpdateFreshInvestigation"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Investigation Report.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_434"}},"schemaId":"schema_434"},{"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/~1freshinvestigations~1{orderId}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_434","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_434"}}},{"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":"/fresh-investigations/updatefreshinvestigationreportcontent"}],"panels":[]}]},"httpPath":"/freshinvestigations/{orderId}"},{"label":"Upload attachments for fresh investigation orderId","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/fresh-investigations/uploadattachmentsforfreshinvestigationorderid","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/fresh-investigations/uploadattachmentsforfreshinvestigationorderid","metadata":{"seo":{"title":"Upload attachments for fresh investigation orderId","description":"Returns the status of attachment upload for the particular order."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"uploadAttachmentsForFreshInvestigationOrderId","name":"Upload attachments for fresh investigation orderId","isWebhook":false,"pointer":"/paths/~1freshinvestigations~1{orderId}~1attachments/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload attachments for fresh investigation orderId","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the status of attachment upload for the particular order."},{"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":"orderId","in":"path","schemaId":"schema_387","description":"Fresh investigation orderId","required":true}],"pointer":"/paths/~1freshinvestigations~1{orderId}~1attachments/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/FreshInvestigationAttachmentUploadForOrderRequest"}},"schemaId":"components/schemas/FreshInvestigationAttachmentUploadForOrderRequest","pointer":"/paths/~1freshinvestigations~1{orderId}~1attachments/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/freshinvestigations/{orderId}/attachments","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"orderId","in":"path","required":true,"schemaId":"schema_387"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"components/schemas/FreshInvestigationAttachmentUploadForOrderRequest"}},"responseCodes":["200","400","401","403","404"],"pointer":"/freshinvestigations/{orderId}/attachments","href":"fresh-investigations/uploadattachmentsforfreshinvestigationorderid","openApiOperationId":"uploadAttachmentsForFreshInvestigationOrderId","summary":"Upload attachments for fresh investigation orderId"},"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/FreshInvestigationAttachmentUploadForOrderRequest","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/FreshInvestigationAttachmentUploadForOrderRequest"}},"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/FreshInvestigationAttachmentUploadForOrderResponse"}},"schemaId":"components/schemas/FreshInvestigationAttachmentUploadForOrderResponse"},{"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/~1freshinvestigations~1{orderId}~1attachments/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/FreshInvestigationAttachmentUploadForOrderResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FreshInvestigationAttachmentUploadForOrderResponse"}}},{"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":"/fresh-investigations/uploadattachmentsforfreshinvestigationorderid"}],"panels":[]}]},"httpPath":"/freshinvestigations/{orderId}/attachments"},{"label":"Get attachments for the given fresh investigation orderId","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/fresh-investigations/getattachmentsforthegivenfreshinvestigationorderid","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/fresh-investigations/getattachmentsforthegivenfreshinvestigationorderid","metadata":{"seo":{"title":"Get attachments for the given fresh investigation orderId","description":"Returns attachments available for that particular order."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAttachmentsForTheGivenFreshInvestigationOrderId","name":"Get attachments for the given fresh investigation orderId","isWebhook":false,"pointer":"/paths/~1freshinvestigations~1{orderId}~1attachments/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get attachments for the given fresh investigation orderId","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns attachments available for that particular order."},{"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":"orderId","in":"path","schemaId":"schema_387","description":"fresh investigation orderId","required":true}],"pointer":"/paths/~1freshinvestigations~1{orderId}~1attachments/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/freshinvestigations/{orderId}/attachments","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"orderId","in":"path","required":true,"schemaId":"schema_387"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/freshinvestigations/{orderId}/attachments","href":"fresh-investigations/getattachmentsforthegivenfreshinvestigationorderid","openApiOperationId":"getAttachmentsForTheGivenFreshInvestigationOrderId","summary":"Get attachments for the given fresh investigation orderId"},"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/FreshInvestigationGetAttachmentsForOrderResponse"}},"schemaId":"components/schemas/FreshInvestigationGetAttachmentsForOrderResponse"},{"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/~1freshinvestigations~1{orderId}~1attachments/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/FreshInvestigationGetAttachmentsForOrderResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FreshInvestigationGetAttachmentsForOrderResponse"}}},{"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":"/fresh-investigations/getattachmentsforthegivenfreshinvestigationorderid"}],"panels":[]}]},"httpPath":"/freshinvestigations/{orderId}/attachments"},{"label":"Get attachment for the given fresh investigation attachment Id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/fresh-investigations/getattachmentforthegivenfreshinvestigationattachmentid","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/fresh-investigations/getattachmentforthegivenfreshinvestigationattachmentid","metadata":{"seo":{"title":"Get attachment for the given fresh investigation attachment Id","description":"Retrieve attachment for the given attachmentId."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAttachmentForTheGivenFreshInvestigationAttachmentId","name":"Get attachment for the given fresh investigation attachment Id","isWebhook":false,"pointer":"/paths/~1freshinvestigations~1{orderId}~1attachments~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get attachment for the given fresh investigation attachment Id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve attachment for the given attachmentId."},{"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":"orderId","in":"path","schemaId":"schema_387","description":"fresh investigation orderId","required":true},{"name":"id","in":"path","schemaId":"schema_387","description":"fresh investigation attachment id for the given order","required":true}],"pointer":"/paths/~1freshinvestigations~1{orderId}~1attachments~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/freshinvestigations/{orderId}/attachments/{id}","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"orderId","in":"path","required":true,"schemaId":"schema_387"},{"name":"id","in":"path","required":true,"schemaId":"schema_387"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/freshinvestigations/{orderId}/attachments/{id}","href":"fresh-investigations/getattachmentforthegivenfreshinvestigationattachmentid","openApiOperationId":"getAttachmentForTheGivenFreshInvestigationAttachmentId","summary":"Get attachment for the given fresh investigation attachment 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","description":"Attachment as a binary stream.","mediaType":"application/*","mediaTypes":["application/*","text/*","image/*"],"mediaTypeContent":{"application/*":{"schemaId":"components/schemas/CreditsafeFreshInvestigationGlobalDataCoreAttachmentBinaryAttachment"},"text/*":{"schemaId":"components/schemas/CreditsafeFreshInvestigationGlobalDataCoreAttachmentBinaryAttachment"},"image/*":{"schemaId":"components/schemas/CreditsafeFreshInvestigationGlobalDataCoreAttachmentBinaryAttachment"}},"schemaId":"components/schemas/CreditsafeFreshInvestigationGlobalDataCoreAttachmentBinaryAttachment"},{"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/~1freshinvestigations~1{orderId}~1attachments~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CreditsafeFreshInvestigationGlobalDataCoreAttachmentBinaryAttachment","mediaTypes":["application/*","text/*","image/*"],"mediaTypeContent":{"application/*":{"schemaId":"components/schemas/CreditsafeFreshInvestigationGlobalDataCoreAttachmentBinaryAttachment"},"text/*":{"schemaId":"components/schemas/CreditsafeFreshInvestigationGlobalDataCoreAttachmentBinaryAttachment"},"image/*":{"schemaId":"components/schemas/CreditsafeFreshInvestigationGlobalDataCoreAttachmentBinaryAttachment"}}},{"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":"/fresh-investigations/getattachmentforthegivenfreshinvestigationattachmentid"}],"panels":[]}]},"httpPath":"/freshinvestigations/{orderId}/attachments/{id}"},{"label":"Comments for fresh investigation orderId","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/fresh-investigations/commentsforfreshinvestigationorderid","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/fresh-investigations/commentsforfreshinvestigationorderid","metadata":{"seo":{"title":"Comments for fresh investigation orderId","description":"Returns the status of comments for the particular order."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"commentsForFreshInvestigationOrderId","name":"Comments for fresh investigation orderId","isWebhook":false,"pointer":"/paths/~1freshinvestigations~1{orderId}~1comments/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Comments for fresh investigation orderId","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the status of comments for the particular order."},{"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":"orderId","in":"path","schemaId":"schema_387","description":"fresh investigation orderId","required":true}],"pointer":"/paths/~1freshinvestigations~1{orderId}~1comments/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/FreshInvestigationCommentsForOrderRequest","exampleIds":["paths/~1freshinvestigations~1{orderId}~1comments/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/FreshInvestigationCommentsForOrderRequest","exampleIds":["paths/~1freshinvestigations~1{orderId}~1comments/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1freshinvestigations~1{orderId}~1comments/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/freshinvestigations/{orderId}/comments","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"orderId","in":"path","required":true,"schemaId":"schema_387"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/FreshInvestigationCommentsForOrderRequest","exampleIds":["paths/~1freshinvestigations~1{orderId}~1comments/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","403","404"],"pointer":"/freshinvestigations/{orderId}/comments","href":"fresh-investigations/commentsforfreshinvestigationorderid","openApiOperationId":"commentsForFreshInvestigationOrderId","summary":"Comments for fresh investigation orderId"},"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/FreshInvestigationCommentsForOrderRequest","exampleIds":["paths/~1freshinvestigations~1{orderId}~1comments/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/FreshInvestigationCommentsForOrderRequest","exampleIds":["paths/~1freshinvestigations~1{orderId}~1comments/post/requestBody/content/application~1json/example"]}},"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/FreshInvestigationCommentsForOrderResponse"}},"schemaId":"components/schemas/FreshInvestigationCommentsForOrderResponse"},{"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/~1freshinvestigations~1{orderId}~1comments/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/FreshInvestigationCommentsForOrderResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FreshInvestigationCommentsForOrderResponse"}}},{"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":"/fresh-investigations/commentsforfreshinvestigationorderid"}],"panels":[]}]},"httpPath":"/freshinvestigations/{orderId}/comments"},{"label":"Retrieve comments of specified FreshInvestigation Report","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/fresh-investigations/retrievecommentsofspecifiedfreshinvestigationreport","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/fresh-investigations/retrievecommentsofspecifiedfreshinvestigationreport","metadata":{"seo":{"title":"Retrieve comments of specified FreshInvestigation Report","description":"Returns the Fresh Investigation Report comments for a specific order."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieveCommentsOfSpecifiedFreshInvestigationReport","name":"Retrieve comments of specified FreshInvestigation Report","isWebhook":false,"pointer":"/paths/~1freshinvestigations~1{orderId}~1comments/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve comments of specified FreshInvestigation Report","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the Fresh Investigation Report comments for a specific order."},{"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":"orderId","in":"path","schemaId":"schema_387","description":"FreshInvestigation Report Id","required":true}],"pointer":"/paths/~1freshinvestigations~1{orderId}~1comments/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/freshinvestigations/{orderId}/comments","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"orderId","in":"path","required":true,"schemaId":"schema_387"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/freshinvestigations/{orderId}/comments","href":"fresh-investigations/retrievecommentsofspecifiedfreshinvestigationreport","openApiOperationId":"retrieveCommentsOfSpecifiedFreshInvestigationReport","summary":"Retrieve comments of specified FreshInvestigation Report"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Investigation Report.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetFreshInvestigationCommentsByOrderIdResponse"}},"schemaId":"components/schemas/GetFreshInvestigationCommentsByOrderIdResponse"},{"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/~1freshinvestigations~1{orderId}~1comments/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetFreshInvestigationCommentsByOrderIdResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetFreshInvestigationCommentsByOrderIdResponse"}}},{"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":"/fresh-investigations/retrievecommentsofspecifiedfreshinvestigationreport"}],"panels":[]}]},"httpPath":"/freshinvestigations/{orderId}/comments"},{"label":"Retrieve FreshInvestigation Report Content","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/fresh-investigations/retrievefreshinvestigationreportcontent","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/fresh-investigations/retrievefreshinvestigationreportcontent","metadata":{"seo":{"title":"Retrieve FreshInvestigation Report Content","description":"Returns the Fresh Investigation Report data for a specific order, after the order has a status of delivered."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieveFreshInvestigationReportContent","name":"Retrieve FreshInvestigation Report Content","isWebhook":false,"pointer":"/paths/~1freshinvestigations~1{orderId}~1report/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve FreshInvestigation Report Content","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the Fresh Investigation Report data for a specific order, after the order has a status of delivered."},{"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":"orderId","in":"path","schemaId":"schema_387","required":true}],"pointer":"/paths/~1freshinvestigations~1{orderId}~1report/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/freshinvestigations/{orderId}/report","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"orderId","in":"path","required":true,"schemaId":"schema_387"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/freshinvestigations/{orderId}/report","href":"fresh-investigations/retrievefreshinvestigationreportcontent","openApiOperationId":"retrieveFreshInvestigationReportContent","summary":"Retrieve FreshInvestigation Report Content"},"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":"Investigation Report.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreditsafeGlobalDataReportsCompanyReportResponse"}},"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/~1freshinvestigations~1{orderId}~1report/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CreditsafeGlobalDataReportsCompanyReportResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreditsafeGlobalDataReportsCompanyReportResponse"}}},{"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":"/fresh-investigations/retrievefreshinvestigationreportcontent"}],"panels":[]}]},"httpPath":"/freshinvestigations/{orderId}/report"}],"content":{"contentType":"group","meta":{"name":"Fresh Investigations"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fresh Investigations","showPageActions":true},{"nodeType":"markdoc","content":"Endpoints to manage Fresh Investigation requests. With the need for\naccurate data, you can check on any company that is not available within\nour instant online database by placing a Fresh Investigation (Offline\nOrder). Depending on the market, the information we obtain will vary.\nUsing official sources and registries we are able to quickly answer\nquestions about a company's stability and financial health. Where official\ninformation is not available we will conduct a direct interview with the\nbusiness."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/freshinvestigations","summary":"Create Fresh Investigation","prefix":{"name":"post","color":"post"},"badges":[],"link":"/fresh-investigations/createfreshinvestigation","deprecated":false},{"title":"/freshinvestigations","summary":"Get Fresh Investigations","prefix":{"name":"get","color":"get"},"badges":[],"link":"/fresh-investigations/getfreshinvestigations","deprecated":false},{"title":"/freshinvestigations/{orderId}","summary":"Retrieve FreshInvestigation Order","prefix":{"name":"get","color":"get"},"badges":[],"link":"/fresh-investigations/retrievefreshinvestigationorder","deprecated":false},{"title":"/freshinvestigations/{orderId}","summary":"Delete Fresh Investigations","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/fresh-investigations/deletefreshinvestigations","deprecated":false},{"title":"/freshinvestigations/{orderId}","summary":"Update FreshInvestigation Report Content","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/fresh-investigations/updatefreshinvestigationreportcontent","deprecated":false},{"title":"/freshinvestigations/{orderId}/attachments","summary":"Upload attachments for fresh investigation orderId","prefix":{"name":"post","color":"post"},"badges":[],"link":"/fresh-investigations/uploadattachmentsforfreshinvestigationorderid","deprecated":false},{"title":"/freshinvestigations/{orderId}/attachments","summary":"Get attachments for the given fresh investigation orderId","prefix":{"name":"get","color":"get"},"badges":[],"link":"/fresh-investigations/getattachmentsforthegivenfreshinvestigationorderid","deprecated":false},{"title":"/freshinvestigations/{orderId}/attachments/{id}","summary":"Get attachment for the given fresh investigation attachment Id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/fresh-investigations/getattachmentforthegivenfreshinvestigationattachmentid","deprecated":false},{"title":"/freshinvestigations/{orderId}/comments","summary":"Comments for fresh investigation orderId","prefix":{"name":"post","color":"post"},"badges":[],"link":"/fresh-investigations/commentsforfreshinvestigationorderid","deprecated":false},{"title":"/freshinvestigations/{orderId}/comments","summary":"Retrieve comments of specified FreshInvestigation Report","prefix":{"name":"get","color":"get"},"badges":[],"link":"/fresh-investigations/retrievecommentsofspecifiedfreshinvestigationreport","deprecated":false},{"title":"/freshinvestigations/{orderId}/report","summary":"Retrieve FreshInvestigation Report Content","prefix":{"name":"get","color":"get"},"badges":[],"link":"/fresh-investigations/retrievefreshinvestigationreportcontent","deprecated":false}]}]}]}]}},{"type":"separator","label":"Data cleaning","content":null},{"type":"group","label":"Create and View All Jobs","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/create-and-view-all-jobs","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/create-and-view-all-jobs","items":[{"label":"Create Job Request","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/create-and-view-all-jobs/createjob","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/create-and-view-all-jobs/createjob","metadata":{"seo":{"title":"Create Job Request","description":"Enter a name for the 'Job Request' to be associated to the file going to be processed."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createJob","name":"Create Job Request","isWebhook":false,"pointer":"/paths/~1dataCleaning~1jobs/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Job Request","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Enter a name for the 'Job Request' to be associated to the file going to be processed."},{"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/ConnectDataCleaningCreateJobRequest","exampleIds":["paths/~1dataCleaning~1jobs/post/requestBody/content/application:json/example"]}},"schemaId":"components/schemas/ConnectDataCleaningCreateJobRequest","exampleIds":["paths/~1dataCleaning~1jobs/post/requestBody/content/application:json/example"],"pointer":"/paths/~1dataCleaning~1jobs/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/dataCleaning/jobs","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/ConnectDataCleaningCreateJobRequest","exampleIds":["paths/~1dataCleaning~1jobs/post/requestBody/content/application:json/example"]}},"responseCodes":["200","400","401","403","404"],"pointer":"/dataCleaning/jobs","href":"create-and-view-all-jobs/createjob","openApiOperationId":"createJob","summary":"Create Job 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/ConnectDataCleaningCreateJobRequest","exampleIds":["paths/~1dataCleaning~1jobs/post/requestBody/content/application:json/example"],"mediaTypes":["application:json"],"mediaTypeSchemas":{"application:json":{"schemaId":"components/schemas/ConnectDataCleaningCreateJobRequest","exampleIds":["paths/~1dataCleaning~1jobs/post/requestBody/content/application:json/example"]}},"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":"components/schemas/ConnectDataCleaningJob"}},"schemaId":"components/schemas/ConnectDataCleaningJob"},{"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/~1dataCleaning~1jobs/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConnectDataCleaningJob","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectDataCleaningJob"}}},{"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":"/create-and-view-all-jobs/createjob"}],"panels":[]}]},"httpPath":"/dataCleaning/jobs"},{"label":"Returns all Data Cleaning Jobs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/create-and-view-all-jobs/getalljobs","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/create-and-view-all-jobs/getalljobs","metadata":{"seo":{"title":"Returns all Data Cleaning Jobs","description":"This endpoint can be used to retrieve all created data cleaning job requests as defined by the query parameters."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAllJobs","name":"Returns all Data Cleaning Jobs","isWebhook":false,"pointer":"/paths/~1dataCleaning~1jobs/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns all Data Cleaning Jobs","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This endpoint can be used to retrieve all created data cleaning job requests as defined by the query parameters."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API requires authentication for access to protected endpoints. Authentication is performed by providing a valid JWT token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"countries","in":"query","schemaId":"schema_387","description":"Comma separated list of ISO/Alpha-2 country codes to filter the results by."},{"name":"status","in":"query","schemaId":"schema_387","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the individual jobs by status. Possible values are: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"processing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"completed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"jobName","in":"query","schemaId":"schema_387","description":"Returns the individual jobs by name."},{"name":"fromDate","in":"query","schemaId":"schema_435","description":"Returns the individual jobs created after the specified date."},{"name":"customerId","in":"query","schemaId":"schema_388","description":"Returns the individual jobs by customer id."},{"name":"toDate","in":"query","schemaId":"schema_435","description":"Returns the individual jobs created before the specified date."},{"name":"userId","in":"query","schemaId":"schema_388","description":"Returns the individual jobs by user id."},{"name":"pageSize","in":"query","schemaId":"schema_388","description":"Returns the number of individual jobs per page."},{"name":"companyName","in":"query","schemaId":"schema_387","description":"Returns the individual jobs by company name."},{"name":"page","in":"query","schemaId":"schema_388","description":"Returns the page number of the individual jobs."},{"name":"archived","in":"query","schemaId":"schema_428","description":"Returns the individual jobs by archived status."}],"pointer":"/paths/~1dataCleaning~1jobs/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/dataCleaning/jobs","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[],"query":[{"name":"countries","in":"query","required":false,"schemaId":"schema_387"},{"name":"status","in":"query","required":false,"schemaId":"schema_387"},{"name":"jobName","in":"query","required":false,"schemaId":"schema_387"},{"name":"fromDate","in":"query","required":false,"schemaId":"schema_435"},{"name":"customerId","in":"query","required":false,"schemaId":"schema_388"},{"name":"toDate","in":"query","required":false,"schemaId":"schema_435"},{"name":"userId","in":"query","required":false,"schemaId":"schema_388"},{"name":"pageSize","in":"query","required":false,"schemaId":"schema_388"},{"name":"companyName","in":"query","required":false,"schemaId":"schema_387"},{"name":"page","in":"query","required":false,"schemaId":"schema_388"},{"name":"archived","in":"query","required":false,"schemaId":"schema_428"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/dataCleaning/jobs","href":"create-and-view-all-jobs/getalljobs","openApiOperationId":"getAllJobs","summary":"Returns all Data Cleaning Jobs"},"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":"200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ArrayOfConnectDataCleaningJob"}},"schemaId":"components/schemas/ArrayOfConnectDataCleaningJob"},{"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/~1dataCleaning~1jobs/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ArrayOfConnectDataCleaningJob","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ArrayOfConnectDataCleaningJob"}}},{"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":"/create-and-view-all-jobs/getalljobs"}],"panels":[]}]},"httpPath":"/dataCleaning/jobs"}],"content":{"contentType":"group","meta":{"name":"Create and View All Jobs"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create and View All Jobs","showPageActions":true},{"nodeType":"markdoc","content":"Create a Data Cleaning job and view all jobs in the system."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/dataCleaning/jobs","summary":"Create Job Request","prefix":{"name":"post","color":"post"},"badges":[],"link":"/create-and-view-all-jobs/createjob","deprecated":false},{"title":"/dataCleaning/jobs","summary":"Returns all Data Cleaning Jobs","prefix":{"name":"get","color":"get"},"badges":[],"link":"/create-and-view-all-jobs/getalljobs","deprecated":false}]}]}]}]}},{"type":"group","label":"Individual Job Management","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/individual-job-management","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/individual-job-management","items":[{"label":"Returns Job by {id} number","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/individual-job-management/getjobbyidnumber","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/individual-job-management/getjobbyidnumber","metadata":{"seo":{"title":"Returns Job by {id} number","description":"Returns Job by {id} number which is generated from 'Creating Job Request' stage. This endpoint is used to check the status of the job."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getJobByIdNumber","name":"Returns Job by {id} number","isWebhook":false,"pointer":"/paths/~1dataCleaning~1jobs~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns Job by {id} number","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns Job by {id} number which is generated from 'Creating Job Request' stage. This endpoint is used to check the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the job."},"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_387","required":true}],"pointer":"/paths/~1dataCleaning~1jobs~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/dataCleaning/jobs/{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_387"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/dataCleaning/jobs/{id}","href":"individual-job-management/getjobbyidnumber","openApiOperationId":"getJobByIdNumber","summary":"Returns Job by {id} number"},"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":"components/schemas/ConnectDataCleaningJob"}},"schemaId":"components/schemas/ConnectDataCleaningJob"},{"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/~1dataCleaning~1jobs~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConnectDataCleaningJob","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectDataCleaningJob"}}},{"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":"/individual-job-management/getjobbyidnumber"}],"panels":[]}]},"httpPath":"/dataCleaning/jobs/{id}"},{"label":"Archive Job by id","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/individual-job-management/archivejob","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/individual-job-management/archivejob","metadata":{"seo":{"title":"Archive Job by id","description":"Archives the job, this can be done at any stage. To have a successful submission a blank response body (See example) is required to be posted."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"archiveJob","name":"Archive Job by id","isWebhook":false,"pointer":"/paths/~1dataCleaning~1jobs~1{id}~1archive/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Archive Job by id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Archives the job, this can be done at any stage. To have a successful submission a blank response body (See example) is required to be posted."},{"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_387","required":true}],"pointer":"/paths/~1dataCleaning~1jobs~1{id}~1archive/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreditsafeGlobalDataReportsCompanyReportExtraSection"}},"schemaId":"components/schemas/CreditsafeGlobalDataReportsCompanyReportExtraSection","pointer":"/paths/~1dataCleaning~1jobs~1{id}~1archive/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/dataCleaning/jobs/{id}/archive","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_387"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreditsafeGlobalDataReportsCompanyReportExtraSection"}},"responseCodes":["200","400","401","403","404"],"pointer":"/dataCleaning/jobs/{id}/archive","href":"individual-job-management/archivejob","openApiOperationId":"archiveJob","summary":"Archive Job 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"}],"schemaId":"components/schemas/CreditsafeGlobalDataReportsCompanyReportExtraSection","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreditsafeGlobalDataReportsCompanyReportExtraSection"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectDataCleaningArchiveResponse"}},"schemaId":"components/schemas/ConnectDataCleaningArchiveResponse"},{"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/~1dataCleaning~1jobs~1{id}~1archive/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConnectDataCleaningArchiveResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectDataCleaningArchiveResponse"}}},{"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":"/individual-job-management/archivejob"}],"panels":[]}]},"httpPath":"/dataCleaning/jobs/{id}/archive"},{"label":"Start Enrichment Request","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/individual-job-management/datacleaningjobenrich","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/individual-job-management/datacleaningjobenrich","metadata":{"seo":{"title":"Start Enrichment Request","description":"Commencing the Job enrichment to the uploaded file after mapping the enrichment requirements. To have a successful submission a blank response body (See example) is required to be posted. POST 'enrich' will not commence unless the Job Status is jobMatchingComplete.Use the GET/dataCleaning/jobs/{id} to check Status of job."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"dataCleaningJobEnrich","name":"Start Enrichment Request","isWebhook":false,"pointer":"/paths/~1dataCleaning~1jobs~1{id}~1enrich/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Start Enrichment 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":"Commencing the Job enrichment to the uploaded file after mapping the enrichment requirements. To have a successful submission a blank response body (See example) is required to be posted."},"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":" POST 'enrich' will not commence unless the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Job Status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"jobMatchingComplete"},"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":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the GET/dataCleaning/jobs/{id} to check Status of job."},"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_387","required":true}],"pointer":"/paths/~1dataCleaning~1jobs~1{id}~1enrich/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreditsafeGlobalDataReportsCompanyReportExtraSection"}},"schemaId":"components/schemas/CreditsafeGlobalDataReportsCompanyReportExtraSection","pointer":"/paths/~1dataCleaning~1jobs~1{id}~1enrich/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/dataCleaning/jobs/{id}/enrich","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_387"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreditsafeGlobalDataReportsCompanyReportExtraSection"}},"responseCodes":["200","400","401","403","404"],"pointer":"/dataCleaning/jobs/{id}/enrich","href":"individual-job-management/datacleaningjobenrich","openApiOperationId":"dataCleaningJobEnrich","summary":"Start Enrichment 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/CreditsafeGlobalDataReportsCompanyReportExtraSection","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreditsafeGlobalDataReportsCompanyReportExtraSection"}},"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":"components/schemas/ArrayOfConnectDataCleaningResponse"}},"schemaId":"components/schemas/ArrayOfConnectDataCleaningResponse"},{"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/~1dataCleaning~1jobs~1{id}~1enrich/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ArrayOfConnectDataCleaningResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ArrayOfConnectDataCleaningResponse"}}},{"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":"/individual-job-management/datacleaningjobenrich"}],"panels":[]}]},"httpPath":"/dataCleaning/jobs/{id}/enrich"},{"label":"Returns Enriched Job File","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/individual-job-management/returnsenrichedjobfile","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/individual-job-management/returnsenrichedjobfile","metadata":{"seo":{"title":"Returns Enriched Job File","description":"Returns the enriched file after enrichment is complete. Identify the file type to be returned via the query parameter."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"returnsEnrichedJobFile","name":"Returns Enriched Job File","isWebhook":false,"pointer":"/paths/~1dataCleaning~1jobs~1{id}~1enrichedFile/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns Enriched Job File","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the enriched file after enrichment is complete. Identify the file type to be returned via the query parameter."},{"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_387","required":true}],"pointer":"/paths/~1dataCleaning~1jobs~1{id}~1enrichedFile/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fileType","in":"query","schemaId":"schema_387","example":"csv"}],"pointer":"/paths/~1dataCleaning~1jobs~1{id}~1enrichedFile/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/dataCleaning/jobs/{id}/enrichedFile","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_387"}],"query":[{"name":"fileType","in":"query","required":false,"example":"csv","schemaId":"schema_387"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/dataCleaning/jobs/{id}/enrichedFile","href":"individual-job-management/returnsenrichedjobfile","openApiOperationId":"returnsEnrichedJobFile","summary":"Returns Enriched Job File"},"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":"200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreditsafeGlobalDataReportsCompanyReportExtraSection","exampleIds":["paths/~1dataCleaning~1jobs~1{id}~1enrichedFile/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/CreditsafeGlobalDataReportsCompanyReportExtraSection","exampleIds":["paths/~1dataCleaning~1jobs~1{id}~1enrichedFile/get/responses/200/content/application~1json/example"]},{"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/~1dataCleaning~1jobs~1{id}~1enrichedFile/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CreditsafeGlobalDataReportsCompanyReportExtraSection","exampleIds":["paths/~1dataCleaning~1jobs~1{id}~1enrichedFile/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreditsafeGlobalDataReportsCompanyReportExtraSection","exampleIds":["paths/~1dataCleaning~1jobs~1{id}~1enrichedFile/get/responses/200/content/application~1json/example"]}}},{"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":"/individual-job-management/returnsenrichedjobfile"}],"panels":[]}]},"httpPath":"/dataCleaning/jobs/{id}/enrichedFile"},{"label":"Update Enrichments Request","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/individual-job-management/updatejobenrichments","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/individual-job-management/updatejobenrichments","metadata":{"seo":{"title":"Update Enrichments Request","description":"Detail which package of enrichment settings are to be applied to the uploaded file. Select one of the three creditTypes to acquire the JSON Enrichment tag schema possible for that product. Removal of Enrichment tags is possible from each creditType. Addition of Enrichment tags to a creditType is not possible beyond the maximum schema for each."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateJobEnrichments","name":"Update Enrichments Request","isWebhook":false,"pointer":"/paths/~1dataCleaning~1jobs~1{id}~1enrichments/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Enrichments 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":"Detail which package of enrichment settings are to be applied to the uploaded file."},"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":" Select one of the three creditTypes to acquire the JSON Enrichment tag schema possible for that product."},"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":" Removal of Enrichment tags is possible from each creditType. Addition of Enrichment tags to a creditType is not possible beyond the maximum schema for each."},"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_387","required":true}],"pointer":"/paths/~1dataCleaning~1jobs~1{id}~1enrichments/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_436"}},"schemaId":"schema_436","pointer":"/paths/~1dataCleaning~1jobs~1{id}~1enrichments/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/dataCleaning/jobs/{id}/enrichments","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_387"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_436"}},"responseCodes":["200","400","401","403","404"],"pointer":"/dataCleaning/jobs/{id}/enrichments","href":"individual-job-management/updatejobenrichments","openApiOperationId":"updateJobEnrichments","summary":"Update Enrichments 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_436","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_436"}},"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":"components/schemas/CreditsafeGlobalDataReportsCompanyReportExtraSection","exampleIds":["paths/~1dataCleaning~1jobs~1{id}~1enrichments/put/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/CreditsafeGlobalDataReportsCompanyReportExtraSection","exampleIds":["paths/~1dataCleaning~1jobs~1{id}~1enrichments/put/responses/200/content/application~1json/example"]},{"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/~1dataCleaning~1jobs~1{id}~1enrichments/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CreditsafeGlobalDataReportsCompanyReportExtraSection","exampleIds":["paths/~1dataCleaning~1jobs~1{id}~1enrichments/put/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreditsafeGlobalDataReportsCompanyReportExtraSection","exampleIds":["paths/~1dataCleaning~1jobs~1{id}~1enrichments/put/responses/200/content/application~1json/example"]}}},{"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":"/individual-job-management/updatejobenrichments"}],"panels":[]}]},"httpPath":"/dataCleaning/jobs/{id}/enrichments"},{"label":"Update Mappings Request","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/individual-job-management/jobupdatemappings","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/individual-job-management/jobupdatemappings","metadata":{"seo":{"title":"Update Mappings Request","description":"Update the mapping of the uploaded file to match that of the header within it. You can add or remove the required number of mapping points in the Request Body."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"jobUpdateMappings","name":"Update Mappings Request","isWebhook":false,"pointer":"/paths/~1dataCleaning~1jobs~1{id}~1mappings/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Mappings Request","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update the mapping of the uploaded file to match that of the header within it. You can add or remove the required number of mapping points in the Request Body."},{"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_387","required":true}],"pointer":"/paths/~1dataCleaning~1jobs~1{id}~1mappings/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ConnectDataCleaningUpdateMappingsRequest"}},"schemaId":"components/schemas/ConnectDataCleaningUpdateMappingsRequest","pointer":"/paths/~1dataCleaning~1jobs~1{id}~1mappings/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/dataCleaning/jobs/{id}/mappings","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_387"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ConnectDataCleaningUpdateMappingsRequest"}},"responseCodes":["200","400","401","403","404"],"pointer":"/dataCleaning/jobs/{id}/mappings","href":"individual-job-management/jobupdatemappings","openApiOperationId":"jobUpdateMappings","summary":"Update Mappings 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/ConnectDataCleaningUpdateMappingsRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ConnectDataCleaningUpdateMappingsRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectDataCleaningMappingResponse"}},"schemaId":"components/schemas/ConnectDataCleaningMappingResponse"},{"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/~1dataCleaning~1jobs~1{id}~1mappings/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConnectDataCleaningMappingResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectDataCleaningMappingResponse"}}},{"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":"/individual-job-management/jobupdatemappings"}],"panels":[]}]},"httpPath":"/dataCleaning/jobs/{id}/mappings"},{"label":"Submit Job Request","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/individual-job-management/submitjobrequest","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/individual-job-management/submitjobrequest","metadata":{"seo":{"title":"Submit Job Request","description":"Submission of the file after mappings have been carried out. To have a successful submission a blank response body (See example) is required to be posted."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"submitJobRequest","name":"Submit Job Request","isWebhook":false,"pointer":"/paths/~1dataCleaning~1jobs~1{id}~1submit/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Submit Job Request","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Submission of the file after mappings have been carried out. To have a successful submission a blank response body (See example) is required to be posted."},{"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_387","required":true}],"pointer":"/paths/~1dataCleaning~1jobs~1{id}~1submit/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreditsafeGlobalDataReportsCompanyReportExtraSection"}},"schemaId":"components/schemas/CreditsafeGlobalDataReportsCompanyReportExtraSection","pointer":"/paths/~1dataCleaning~1jobs~1{id}~1submit/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/dataCleaning/jobs/{id}/submit","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_387"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreditsafeGlobalDataReportsCompanyReportExtraSection"}},"responseCodes":["200","400","401","403","404"],"pointer":"/dataCleaning/jobs/{id}/submit","href":"individual-job-management/submitjobrequest","openApiOperationId":"submitJobRequest","summary":"Submit Job 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/CreditsafeGlobalDataReportsCompanyReportExtraSection","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreditsafeGlobalDataReportsCompanyReportExtraSection"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreditsafeGlobalDataReportsCompanyReportExtraSection","exampleIds":["paths/~1dataCleaning~1jobs~1{id}~1submit/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/CreditsafeGlobalDataReportsCompanyReportExtraSection","exampleIds":["paths/~1dataCleaning~1jobs~1{id}~1submit/post/responses/200/content/application~1json/example"]},{"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/~1dataCleaning~1jobs~1{id}~1submit/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CreditsafeGlobalDataReportsCompanyReportExtraSection","exampleIds":["paths/~1dataCleaning~1jobs~1{id}~1submit/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreditsafeGlobalDataReportsCompanyReportExtraSection","exampleIds":["paths/~1dataCleaning~1jobs~1{id}~1submit/post/responses/200/content/application~1json/example"]}}},{"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":"/individual-job-management/submitjobrequest"}],"panels":[]}]},"httpPath":"/dataCleaning/jobs/{id}/submit"},{"label":"Upload a Job File with an {id}","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/individual-job-management/jobfileuploadwithid","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/individual-job-management/jobfileuploadwithid","metadata":{"seo":{"title":"Upload a Job File with an {id}","description":"Upload a Job File for processing, you need to link to the {id} number generated from the 'Job Request'."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"jobFileUploadWithId","name":"Upload a Job File with an {id}","isWebhook":false,"pointer":"/paths/~1dataCleaning~1jobs~1{id}~1upload/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload a Job File with an {id}","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":"Upload a Job File for processing, you need to link to the {id} number generated from the 'Job 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_387","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The {id} number generated from the 'Job Request'."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1dataCleaning~1jobs~1{id}~1upload/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/MODEL28cf8d"}},"schemaId":"components/schemas/MODEL28cf8d","pointer":"/paths/~1dataCleaning~1jobs~1{id}~1upload/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/dataCleaning/jobs/{id}/upload","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_387"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"components/schemas/MODEL28cf8d"}},"responseCodes":["200","400","401","403","404"],"pointer":"/dataCleaning/jobs/{id}/upload","href":"individual-job-management/jobfileuploadwithid","openApiOperationId":"jobFileUploadWithId","summary":"Upload a Job File with an {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"}],"schemaId":"components/schemas/MODEL28cf8d","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/MODEL28cf8d"}},"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":"components/schemas/ConnectDataCleaningUploadResponse"}},"schemaId":"components/schemas/ConnectDataCleaningUploadResponse"},{"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/~1dataCleaning~1jobs~1{id}~1upload/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConnectDataCleaningUploadResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectDataCleaningUploadResponse"}}},{"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":"/individual-job-management/jobfileuploadwithid"}],"panels":[]}]},"httpPath":"/dataCleaning/jobs/{id}/upload"}],"content":{"contentType":"group","meta":{"name":"Individual Job Management"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Individual Job Management","showPageActions":true},{"nodeType":"markdoc","content":"Manage individual Data Cleaning jobs. Including updating required mappings and enrichment processes."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/dataCleaning/jobs/{id}","summary":"Returns Job by {id} number","prefix":{"name":"get","color":"get"},"badges":[],"link":"/individual-job-management/getjobbyidnumber","deprecated":false},{"title":"/dataCleaning/jobs/{id}/archive","summary":"Archive Job by id","prefix":{"name":"post","color":"post"},"badges":[],"link":"/individual-job-management/archivejob","deprecated":false},{"title":"/dataCleaning/jobs/{id}/enrich","summary":"Start Enrichment Request","prefix":{"name":"post","color":"post"},"badges":[],"link":"/individual-job-management/datacleaningjobenrich","deprecated":false},{"title":"/dataCleaning/jobs/{id}/enrichedFile","summary":"Returns Enriched Job File","prefix":{"name":"get","color":"get"},"badges":[],"link":"/individual-job-management/returnsenrichedjobfile","deprecated":false},{"title":"/dataCleaning/jobs/{id}/enrichments","summary":"Update Enrichments Request","prefix":{"name":"put","color":"put"},"badges":[],"link":"/individual-job-management/updatejobenrichments","deprecated":false},{"title":"/dataCleaning/jobs/{id}/mappings","summary":"Update Mappings Request","prefix":{"name":"put","color":"put"},"badges":[],"link":"/individual-job-management/jobupdatemappings","deprecated":false},{"title":"/dataCleaning/jobs/{id}/submit","summary":"Submit Job Request","prefix":{"name":"post","color":"post"},"badges":[],"link":"/individual-job-management/submitjobrequest","deprecated":false},{"title":"/dataCleaning/jobs/{id}/upload","summary":"Upload a Job File with an {id}","prefix":{"name":"post","color":"post"},"badges":[],"link":"/individual-job-management/jobfileuploadwithid","deprecated":false}]}]}]}]}},{"type":"separator","label":"Global monitoring","content":null},{"type":"group","label":"User Details","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/user-details","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/user-details","items":[{"label":"Monitoring User Details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/user-details/monitoringuserdetails","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/user-details/monitoringuserdetails","metadata":{"seo":{"title":"Monitoring User Details","description":"You would use this endpoint to retrieve the user details related to the Global Monitoring product, such as the user's information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"monitoringUserDetails","name":"Monitoring User Details","isWebhook":false,"pointer":"/paths/~1monitoring~1user~1details/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Monitoring User Details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"You would use this endpoint to retrieve the user details related to the Global Monitoring product, such as the user's information."},{"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":"/monitoring/user/details","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","404"],"pointer":"/monitoring/user/details","href":"user-details/monitoringuserdetails","openApiOperationId":"monitoringUserDetails","summary":"Monitoring User Details"},"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/ConnectMonitoringUserDetails"}},"schemaId":"components/schemas/ConnectMonitoringUserDetails"},{"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/~1monitoring~1user~1details/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConnectMonitoringUserDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringUserDetails"}}},{"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":"/user-details/monitoringuserdetails"}],"panels":[]}]},"httpPath":"/monitoring/user/details"}],"content":{"contentType":"group","meta":{"name":"User Details"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"User Details","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/monitoring/user/details","summary":"Monitoring User Details","prefix":{"name":"get","color":"get"},"badges":[],"link":"/user-details/monitoringuserdetails","deprecated":false}]}]}]}]}},{"type":"group","label":"Create and View All Portfolios","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/create-and-view-all-portfolios","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/create-and-view-all-portfolios","items":[{"label":"List All Portfolios","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/create-and-view-all-portfolios/listallportfolios","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/create-and-view-all-portfolios/listallportfolios","metadata":{"seo":{"title":"List All Portfolios","description":"This endpoint allows you to manage portfolios. You can use the GET method to retrieve all portfolios associated with the user."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listAllPortfolios","name":"List All Portfolios","isWebhook":false,"pointer":"/paths/~1monitoring~1portfolios/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List All Portfolios","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This endpoint allows you to manage portfolios. You can use the GET method to retrieve all portfolios associated with the user."},{"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":"searchQuery","in":"query","schemaId":"schema_387","description":"Return portfolios that match the given value"},{"name":"page","in":"query","schemaId":"schema_437","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Starting page number inGlobal Monitoring is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If all items are displayed on one page this can also be left blank."},"children":[]}]}]}]},{"name":"pageSize","in":"query","schemaId":"schema_388","description":"Specifies the number of items to be displayed per page. Allowed values are between 1 and 100."}],"pointer":"/paths/~1monitoring~1portfolios/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/monitoring/portfolios","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[],"query":[{"name":"searchQuery","in":"query","schemaId":"schema_387"},{"name":"page","in":"query","schemaId":"schema_437"},{"name":"pageSize","in":"query","schemaId":"schema_388"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/monitoring/portfolios","href":"create-and-view-all-portfolios/listallportfolios","openApiOperationId":"listAllPortfolios","summary":"List All Portfolios"},"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/ConnectMonitoringListPortfolios"}},"schemaId":"components/schemas/ConnectMonitoringListPortfolios"},{"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/~1monitoring~1portfolios/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConnectMonitoringListPortfolios","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringListPortfolios"}}},{"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":"/create-and-view-all-portfolios/listallportfolios"}],"panels":[]}]},"httpPath":"/monitoring/portfolios"},{"label":"Create Monitoring Portfolio","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/create-and-view-all-portfolios/createmonitoringportfolio","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/create-and-view-all-portfolios/createmonitoringportfolio","metadata":{"seo":{"title":"Create Monitoring Portfolio","description":"This endpoint to create a new Portfolio based on the supplied criteria. A portfolio can contain any number of companies that you wish to monitor changes to. The only required Body parameter is \"name\" for Connect users."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createMonitoringPortfolio","name":"Create Monitoring Portfolio","isWebhook":false,"pointer":"/paths/~1monitoring~1portfolios/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Monitoring Portfolio","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 to create a new Portfolio based on the supplied criteria."},"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":" A portfolio can contain any number of companies that you wish to monitor changes to. The only required Body parameter is \"name\" for Connect users."},"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","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringCreatePortfolioRequest"}},"schemaId":"components/schemas/ConnectMonitoringCreatePortfolioRequest","pointer":"/paths/~1monitoring~1portfolios/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/monitoring/portfolios","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/ConnectMonitoringCreatePortfolioRequest"}},"responseCodes":["200","400","401","403","404"],"pointer":"/monitoring/portfolios","href":"create-and-view-all-portfolios/createmonitoringportfolio","openApiOperationId":"createMonitoringPortfolio","summary":"Create Monitoring Portfolio"},"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/ConnectMonitoringCreatePortfolioRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringCreatePortfolioRequest"}},"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/ConnectMonitoringCreatePortfolioResponse"}},"schemaId":"components/schemas/ConnectMonitoringCreatePortfolioResponse"},{"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/~1monitoring~1portfolios/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConnectMonitoringCreatePortfolioResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringCreatePortfolioResponse"}}},{"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":"/create-and-view-all-portfolios/createmonitoringportfolio"}],"panels":[]}]},"httpPath":"/monitoring/portfolios"}],"content":{"contentType":"group","meta":{"name":"Create and View All Portfolios"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create and View All Portfolios","showPageActions":true},{"nodeType":"markdoc","content":"Endpoints to create new portfolios and retrieve a list of all existing portfolios for monitoring."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/monitoring/portfolios","summary":"List All Portfolios","prefix":{"name":"get","color":"get"},"badges":[],"link":"/create-and-view-all-portfolios/listallportfolios","deprecated":false},{"title":"/monitoring/portfolios","summary":"Create Monitoring Portfolio","prefix":{"name":"post","color":"post"},"badges":[],"link":"/create-and-view-all-portfolios/createmonitoringportfolio","deprecated":false}]}]}]}]}},{"type":"group","label":"Importing Portfolios","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/importing-portfolios","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/importing-portfolios","items":[{"label":"Import A Portfolio File","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/importing-portfolios/importaportfoliofile","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/importing-portfolios/importaportfoliofile","metadata":{"seo":{"title":"Import A Portfolio File","description":"Endpoint allows you to import a list of companies to add to the selected portfolio along with some personal information for the company.Importing a portfolio will add the companies to the specified portfolio, duplicates in the import file will be ignored. You may also optionally add an email to the body of the request and get an email notification when the import is processed.IMPORTANT:  Detailed information on the structure of the CSV file and file size limits can be found in the help documentation: Import and Sync Companies documentation"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"importAPortfolioFile","name":"Import A Portfolio File","isWebhook":false,"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1import/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Import A Portfolio File","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 allows you to import a list of companies to add to the selected portfolio along with some personal information for the company."},"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":"Importing a portfolio will add the companies to the specified portfolio, duplicates in the import file will be ignored. "},"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":"You may also optionally add an email to the body of the request and get an email notification when the import is processed."},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IMPORTANT"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":  Detailed information on the structure of the CSV file and file size limits can be found in the help documentation: "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://doc.creditsafe.com/connect-apis-catalog/product-catalog/globalmonitoring/documentation/importandsynccompanies","target":"_blank","rel":"noopener noreferrer"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Import and Sync Companies documentation"},"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":"portfolioId","in":"path","schemaId":"schema_438","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier of the portfolio, obtained from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/portfolios"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1import/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/ConnectMonitoringImportAndSyncPortfolioRequest","exampleIds":["paths/~1monitoring~1portfolios~1{portfolioId}~1import/post/requestBody/content/multipart~1form-data/example"]}},"schemaId":"components/schemas/ConnectMonitoringImportAndSyncPortfolioRequest","exampleIds":["paths/~1monitoring~1portfolios~1{portfolioId}~1import/post/requestBody/content/multipart~1form-data/example"],"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1import/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/monitoring/portfolios/{portfolioId}/import","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"portfolioId","in":"path","required":true,"schemaId":"schema_438"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"components/schemas/ConnectMonitoringImportAndSyncPortfolioRequest","exampleIds":["paths/~1monitoring~1portfolios~1{portfolioId}~1import/post/requestBody/content/multipart~1form-data/example"]}},"responseCodes":["200","400","401","403","404"],"pointer":"/monitoring/portfolios/{portfolioId}/import","href":"importing-portfolios/importaportfoliofile","openApiOperationId":"importAPortfolioFile","summary":"Import A Portfolio File"},"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/ConnectMonitoringImportAndSyncPortfolioRequest","exampleIds":["paths/~1monitoring~1portfolios~1{portfolioId}~1import/post/requestBody/content/multipart~1form-data/example"],"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/ConnectMonitoringImportAndSyncPortfolioRequest","exampleIds":["paths/~1monitoring~1portfolios~1{portfolioId}~1import/post/requestBody/content/multipart~1form-data/example"]}},"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/ConnectMonitoringImportAndSyncPortfolioResponse"}},"schemaId":"components/schemas/ConnectMonitoringImportAndSyncPortfolioResponse"},{"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/~1monitoring~1portfolios~1{portfolioId}~1import/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConnectMonitoringImportAndSyncPortfolioResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringImportAndSyncPortfolioResponse"}}},{"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":"/importing-portfolios/importaportfoliofile"}],"panels":[]}]},"httpPath":"/monitoring/portfolios/{portfolioId}/import"},{"label":"Sync A Portfolio File","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/importing-portfolios/syncaportfoliofile","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/importing-portfolios/syncaportfoliofile","metadata":{"seo":{"title":"Sync A Portfolio File","description":"Endpoint allows you to sync a portfolio file with your portfolio.  Sync action will delete all companies in your specified portfolio, and then add the companies from the file into the portfolio. IMPORTANT:  Detailed information on the structure of the CSV file and file size limits can be found in the help documentation: Import and Sync Companies documentation"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"syncAPortfolioFile","name":"Sync A Portfolio File","isWebhook":false,"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1sync/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Sync A Portfolio File","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 allows you to sync a portfolio file with your portfolio. "},"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":" Sync action will delete all companies in your specified portfolio, and then add the companies from the file into the portfolio. "},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IMPORTANT"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":  Detailed information on the structure of the CSV file and file size limits can be found in the help documentation: "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://doc.creditsafe.com/connect-apis-catalog/product-catalog/globalmonitoring/documentation/importandsynccompanies","target":"_blank","rel":"noopener noreferrer"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Import and Sync Companies documentation"},"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":"portfolioId","in":"path","schemaId":"schema_438","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier of the portfolio, obtained from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/portfolios"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1sync/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/ConnectMonitoringImportAndSyncPortfolioRequest","exampleIds":["paths/~1monitoring~1portfolios~1{portfolioId}~1sync/post/requestBody/content/multipart~1form-data/example"]}},"schemaId":"components/schemas/ConnectMonitoringImportAndSyncPortfolioRequest","exampleIds":["paths/~1monitoring~1portfolios~1{portfolioId}~1sync/post/requestBody/content/multipart~1form-data/example"],"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1sync/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/monitoring/portfolios/{portfolioId}/sync","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"portfolioId","in":"path","required":true,"schemaId":"schema_438"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"components/schemas/ConnectMonitoringImportAndSyncPortfolioRequest","exampleIds":["paths/~1monitoring~1portfolios~1{portfolioId}~1sync/post/requestBody/content/multipart~1form-data/example"]}},"responseCodes":["200","400","401","403","404"],"pointer":"/monitoring/portfolios/{portfolioId}/sync","href":"importing-portfolios/syncaportfoliofile","openApiOperationId":"syncAPortfolioFile","summary":"Sync A Portfolio File"},"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/ConnectMonitoringImportAndSyncPortfolioRequest","exampleIds":["paths/~1monitoring~1portfolios~1{portfolioId}~1sync/post/requestBody/content/multipart~1form-data/example"],"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/ConnectMonitoringImportAndSyncPortfolioRequest","exampleIds":["paths/~1monitoring~1portfolios~1{portfolioId}~1sync/post/requestBody/content/multipart~1form-data/example"]}},"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/ConnectMonitoringImportAndSyncPortfolioResponse"}},"schemaId":"components/schemas/ConnectMonitoringImportAndSyncPortfolioResponse"},{"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/~1monitoring~1portfolios~1{portfolioId}~1sync/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConnectMonitoringImportAndSyncPortfolioResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringImportAndSyncPortfolioResponse"}}},{"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":"/importing-portfolios/syncaportfoliofile"}],"panels":[]}]},"httpPath":"/monitoring/portfolios/{portfolioId}/sync"}],"content":{"contentType":"group","meta":{"name":"Importing Portfolios"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Importing Portfolios","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/monitoring/portfolios/{portfolioId}/import","summary":"Import A Portfolio File","prefix":{"name":"post","color":"post"},"badges":[],"link":"/importing-portfolios/importaportfoliofile","deprecated":false},{"title":"/monitoring/portfolios/{portfolioId}/sync","summary":"Sync A Portfolio File","prefix":{"name":"post","color":"post"},"badges":[],"link":"/importing-portfolios/syncaportfoliofile","deprecated":false}]}]}]}]}},{"type":"group","label":"User Management of Portfolios","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/user-management-of-portfolios","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/user-management-of-portfolios","items":[{"label":"Retrieve Portfolio By Id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/user-management-of-portfolios/retrieveportfoliobyid","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/user-management-of-portfolios/retrieveportfoliobyid","metadata":{"seo":{"title":"Retrieve Portfolio By Id","description":"This endpoint allows you to retrieve the portfolio details from the portfolioId."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrievePortfolioById","name":"Retrieve Portfolio By Id","isWebhook":false,"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve Portfolio 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 allows you to retrieve the portfolio details from the portfolioId."},{"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":"portfolioId","in":"path","schemaId":"schema_438","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier for the portfolio that you wish to retrieve, obtained from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/portfolios"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/monitoring/portfolios/{portfolioId}","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"portfolioId","in":"path","required":true,"schemaId":"schema_438"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/monitoring/portfolios/{portfolioId}","href":"user-management-of-portfolios/retrieveportfoliobyid","openApiOperationId":"retrievePortfolioById","summary":"Retrieve Portfolio 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/ConnectMonitoringGetPortfolioById"}},"schemaId":"components/schemas/ConnectMonitoringGetPortfolioById"},{"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/~1monitoring~1portfolios~1{portfolioId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConnectMonitoringGetPortfolioById","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringGetPortfolioById"}}},{"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":"/user-management-of-portfolios/retrieveportfoliobyid"}],"panels":[]}]},"httpPath":"/monitoring/portfolios/{portfolioId}"},{"label":"Delete Portfolio","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/user-management-of-portfolios/deleteportfolio","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/user-management-of-portfolios/deleteportfolio","metadata":{"seo":{"title":"Delete Portfolio","description":"This endpoint allows you to delete the portfolio using the portfolioId."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deletePortfolio","name":"Delete Portfolio","isWebhook":false,"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Portfolio","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This endpoint allows you to delete the portfolio using the portfolioId."},{"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":"portfolioId","in":"path","schemaId":"schema_438","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier of the portfolio that you wish to delete, obtained from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/portfolios"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/monitoring/portfolios/{portfolioId}","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"portfolioId","in":"path","required":true,"schemaId":"schema_438"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/monitoring/portfolios/{portfolioId}","href":"user-management-of-portfolios/deleteportfolio","openApiOperationId":"deletePortfolio","summary":"Delete Portfolio"},"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/ConnectMonitoringDeletePortfolio"}},"schemaId":"components/schemas/ConnectMonitoringDeletePortfolio"},{"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/~1monitoring~1portfolios~1{portfolioId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConnectMonitoringDeletePortfolio","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringDeletePortfolio"}}},{"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":"/user-management-of-portfolios/deleteportfolio"}],"panels":[]}]},"httpPath":"/monitoring/portfolios/{portfolioId}"},{"label":"Update Portfolio Details","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/user-management-of-portfolios/updateportfoliodetails","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/user-management-of-portfolios/updateportfoliodetails","metadata":{"seo":{"title":"Update Portfolio Details","description":"This endpoint allows you to update Portfolio details such as Name, email recipients, language and subject line."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updatePortfolioDetails","name":"Update Portfolio Details","isWebhook":false,"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Portfolio Details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This endpoint allows you to update Portfolio details such as Name, email recipients, language and subject line."},{"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":"portfolioId","in":"path","schemaId":"schema_438","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier of the portfolio, obtained from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/portfolios"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringUpdatePortfolioRequest","exampleIds":["paths/~1monitoring~1portfolios~1{portfolioId}/patch/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/ConnectMonitoringUpdatePortfolioRequest","exampleIds":["paths/~1monitoring~1portfolios~1{portfolioId}/patch/requestBody/content/application~1json/example"],"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/monitoring/portfolios/{portfolioId}","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"portfolioId","in":"path","required":true,"schemaId":"schema_438"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringUpdatePortfolioRequest","exampleIds":["paths/~1monitoring~1portfolios~1{portfolioId}/patch/requestBody/content/application~1json/example"]}},"responseCodes":["204","400","401","403","404"],"pointer":"/monitoring/portfolios/{portfolioId}","href":"user-management-of-portfolios/updateportfoliodetails","openApiOperationId":"updatePortfolioDetails","summary":"Update Portfolio Details"},"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/ConnectMonitoringUpdatePortfolioRequest","exampleIds":["paths/~1monitoring~1portfolios~1{portfolioId}/patch/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringUpdatePortfolioRequest","exampleIds":["paths/~1monitoring~1portfolios~1{portfolioId}/patch/requestBody/content/application~1json/example"]}},"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","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_439"}},"schemaId":"schema_439"},{"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/~1monitoring~1portfolios~1{portfolioId}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204","schemaId":"schema_439","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_439"}}},{"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":"/user-management-of-portfolios/updateportfoliodetails"}],"panels":[]}]},"httpPath":"/monitoring/portfolios/{portfolioId}"},{"label":"Copy Companies Between Portfolios","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/user-management-of-portfolios/copycompaniesbetweenportfolios","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/user-management-of-portfolios/copycompaniesbetweenportfolios","metadata":{"seo":{"title":"Copy Companies Between Portfolios","description":"This endpoint allows you to copy companies from one portfolio to another. You can specify the source and destination portfolios to perform the copy operation."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"copyCompaniesBetweenPortfolios","name":"Copy Companies Between Portfolios","isWebhook":false,"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1companies~1copy/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Copy Companies Between Portfolios","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This endpoint allows you to copy companies from one portfolio to another. You can specify the source and destination portfolios to perform the copy operation."},{"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":"portfolioId","in":"path","schemaId":"schema_438","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier of the portfolio you want to copy companies from, obtained from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/portfolios"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1companies~1copy/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"copyAll","in":"query","schemaId":"schema_392","description":"When CopyAll query parameter is False, portfolios and companies list needs to be passed. When CopyAll query parameter is True, only portfolios need to be passed and companies List must be empty. All companies are copied from current portfolio are considered here."}],"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1companies~1copy/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringCopyAndMoveCompaniesRequest","exampleIds":["paths/~1monitoring~1portfolios~1{portfolioId}~1companies~1copy/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/ConnectMonitoringCopyAndMoveCompaniesRequest","exampleIds":["paths/~1monitoring~1portfolios~1{portfolioId}~1companies~1copy/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1companies~1copy/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/monitoring/portfolios/{portfolioId}/companies/copy","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"portfolioId","in":"path","required":true,"schemaId":"schema_438"}],"query":[{"name":"copyAll","in":"query","schemaId":"schema_392"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringCopyAndMoveCompaniesRequest","exampleIds":["paths/~1monitoring~1portfolios~1{portfolioId}~1companies~1copy/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","403","404"],"pointer":"/monitoring/portfolios/{portfolioId}/companies/copy","href":"user-management-of-portfolios/copycompaniesbetweenportfolios","openApiOperationId":"copyCompaniesBetweenPortfolios","summary":"Copy Companies Between Portfolios"},"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/ConnectMonitoringCopyAndMoveCompaniesRequest","exampleIds":["paths/~1monitoring~1portfolios~1{portfolioId}~1companies~1copy/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringCopyAndMoveCompaniesRequest","exampleIds":["paths/~1monitoring~1portfolios~1{portfolioId}~1companies~1copy/post/requestBody/content/application~1json/example"]}},"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/ConnectMonitoringCopyAndMoveCompaniesResponse"}},"schemaId":"components/schemas/ConnectMonitoringCopyAndMoveCompaniesResponse"},{"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/~1monitoring~1portfolios~1{portfolioId}~1companies~1copy/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConnectMonitoringCopyAndMoveCompaniesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringCopyAndMoveCompaniesResponse"}}},{"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":"/user-management-of-portfolios/copycompaniesbetweenportfolios"}],"panels":[]}]},"httpPath":"/monitoring/portfolios/{portfolioId}/companies/copy"},{"label":"Move Companies Between Portfolios","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/user-management-of-portfolios/movecompaniesbetweenportfolios","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/user-management-of-portfolios/movecompaniesbetweenportfolios","metadata":{"seo":{"title":"Move Companies Between Portfolios","description":"This endpoint allows you to move companies from one portfolio to single (or) multiple portfolios. Removes the companies from the portfolio provided in the path parameter."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"moveCompaniesBetweenPortfolios","name":"Move Companies Between Portfolios","isWebhook":false,"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1companies~1remove/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Move Companies Between Portfolios","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This endpoint allows you to move companies from one portfolio to single (or) multiple portfolios. Removes the companies from the portfolio provided in the path parameter."},{"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":"portfolioId","in":"path","schemaId":"schema_438","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier of the portfolio you want to move companies from, obtained from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/portfolios"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1companies~1remove/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"removeAll","in":"query","schemaId":"schema_392","description":"When RemoveAll query parameter is False, a portfolios and companies list needs to be passed. When RemoveAll query parameter is True, only portfolios need to be passed and companies List must be empty. All companies are moved and deleted from current portfolio."}],"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1companies~1remove/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringCopyAndMoveCompaniesRequest","exampleIds":["paths/~1monitoring~1portfolios~1{portfolioId}~1companies~1remove/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/ConnectMonitoringCopyAndMoveCompaniesRequest","exampleIds":["paths/~1monitoring~1portfolios~1{portfolioId}~1companies~1remove/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1companies~1remove/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/monitoring/portfolios/{portfolioId}/companies/remove","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"portfolioId","in":"path","required":true,"schemaId":"schema_438"}],"query":[{"name":"removeAll","in":"query","schemaId":"schema_392"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringCopyAndMoveCompaniesRequest","exampleIds":["paths/~1monitoring~1portfolios~1{portfolioId}~1companies~1remove/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","403","404"],"pointer":"/monitoring/portfolios/{portfolioId}/companies/remove","href":"user-management-of-portfolios/movecompaniesbetweenportfolios","openApiOperationId":"moveCompaniesBetweenPortfolios","summary":"Move Companies Between Portfolios"},"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/ConnectMonitoringCopyAndMoveCompaniesRequest","exampleIds":["paths/~1monitoring~1portfolios~1{portfolioId}~1companies~1remove/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringCopyAndMoveCompaniesRequest","exampleIds":["paths/~1monitoring~1portfolios~1{portfolioId}~1companies~1remove/post/requestBody/content/application~1json/example"]}},"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/ConnectMonitoringCopyAndMoveCompaniesResponse"}},"schemaId":"components/schemas/ConnectMonitoringCopyAndMoveCompaniesResponse"},{"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/~1monitoring~1portfolios~1{portfolioId}~1companies~1remove/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConnectMonitoringCopyAndMoveCompaniesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringCopyAndMoveCompaniesResponse"}}},{"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":"/user-management-of-portfolios/movecompaniesbetweenportfolios"}],"panels":[]}]},"httpPath":"/monitoring/portfolios/{portfolioId}/companies/remove"},{"label":"Portfolio User Permissions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/user-management-of-portfolios/portfoliouserpermissions","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/user-management-of-portfolios/portfoliouserpermissions","metadata":{"seo":{"title":"Portfolio User Permissions","description":"Retrieve user permissions within the customer for a portfolio."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"portfolioUserPermissions","name":"Portfolio User Permissions","isWebhook":false,"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1sharingPermissions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Portfolio User Permissions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve user permissions within the customer for a portfolio."},{"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":"portfolioId","in":"path","schemaId":"schema_438","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier of the portfolio, obtained from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/portfolios"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1sharingPermissions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/monitoring/portfolios/{portfolioId}/sharingPermissions","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"portfolioId","in":"path","required":true,"schemaId":"schema_438"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/monitoring/portfolios/{portfolioId}/sharingPermissions","href":"user-management-of-portfolios/portfoliouserpermissions","openApiOperationId":"portfolioUserPermissions","summary":"Portfolio User Permissions"},"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/ConnectMonitoringListSharingPermissions"}},"schemaId":"components/schemas/ConnectMonitoringListSharingPermissions"},{"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/~1monitoring~1portfolios~1{portfolioId}~1sharingPermissions/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConnectMonitoringListSharingPermissions","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringListSharingPermissions"}}},{"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":"/user-management-of-portfolios/portfoliouserpermissions"}],"panels":[]}]},"httpPath":"/monitoring/portfolios/{portfolioId}/sharingPermissions"},{"label":"Share Portfolio With Users","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/user-management-of-portfolios/shareportfoliowithusers","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/user-management-of-portfolios/shareportfoliowithusers","metadata":{"seo":{"title":"Share Portfolio With Users","description":"Update/Create user permissions within the customer for portfolio."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"sharePortfolioWithUsers","name":"Share Portfolio With Users","isWebhook":false,"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1sharingPermissions/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Share Portfolio With Users","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update/Create user permissions within the customer for portfolio."},{"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":"portfolioId","in":"path","schemaId":"schema_438","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier of the portfolio, obtained from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/portfolios"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1sharingPermissions/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringSharePortfolioRequest","exampleIds":["paths/~1monitoring~1portfolios~1{portfolioId}~1sharingPermissions/patch/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/ConnectMonitoringSharePortfolioRequest","exampleIds":["paths/~1monitoring~1portfolios~1{portfolioId}~1sharingPermissions/patch/requestBody/content/application~1json/example"],"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1sharingPermissions/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/monitoring/portfolios/{portfolioId}/sharingPermissions","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"portfolioId","in":"path","required":true,"schemaId":"schema_438"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringSharePortfolioRequest","exampleIds":["paths/~1monitoring~1portfolios~1{portfolioId}~1sharingPermissions/patch/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","403","404"],"pointer":"/monitoring/portfolios/{portfolioId}/sharingPermissions","href":"user-management-of-portfolios/shareportfoliowithusers","openApiOperationId":"sharePortfolioWithUsers","summary":"Share Portfolio With Users"},"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/ConnectMonitoringSharePortfolioRequest","exampleIds":["paths/~1monitoring~1portfolios~1{portfolioId}~1sharingPermissions/patch/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringSharePortfolioRequest","exampleIds":["paths/~1monitoring~1portfolios~1{portfolioId}~1sharingPermissions/patch/requestBody/content/application~1json/example"]}},"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/ConnectMonitoringSharePortfolioRequestResponse"}},"schemaId":"components/schemas/ConnectMonitoringSharePortfolioRequestResponse"},{"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/~1monitoring~1portfolios~1{portfolioId}~1sharingPermissions/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConnectMonitoringSharePortfolioRequestResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringSharePortfolioRequestResponse"}}},{"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":"/user-management-of-portfolios/shareportfoliowithusers"}],"panels":[]}]},"httpPath":"/monitoring/portfolios/{portfolioId}/sharingPermissions"}],"content":{"contentType":"group","meta":{"name":"User Management of Portfolios"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"User Management of Portfolios","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/monitoring/portfolios/{portfolioId}","summary":"Retrieve Portfolio By Id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/user-management-of-portfolios/retrieveportfoliobyid","deprecated":false},{"title":"/monitoring/portfolios/{portfolioId}","summary":"Delete Portfolio","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/user-management-of-portfolios/deleteportfolio","deprecated":false},{"title":"/monitoring/portfolios/{portfolioId}","summary":"Update Portfolio Details","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/user-management-of-portfolios/updateportfoliodetails","deprecated":false},{"title":"/monitoring/portfolios/{portfolioId}/companies/copy","summary":"Copy Companies Between Portfolios","prefix":{"name":"post","color":"post"},"badges":[],"link":"/user-management-of-portfolios/copycompaniesbetweenportfolios","deprecated":false},{"title":"/monitoring/portfolios/{portfolioId}/companies/remove","summary":"Move Companies Between Portfolios","prefix":{"name":"post","color":"post"},"badges":[],"link":"/user-management-of-portfolios/movecompaniesbetweenportfolios","deprecated":false},{"title":"/monitoring/portfolios/{portfolioId}/sharingPermissions","summary":"Portfolio User Permissions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/user-management-of-portfolios/portfoliouserpermissions","deprecated":false},{"title":"/monitoring/portfolios/{portfolioId}/sharingPermissions","summary":"Share Portfolio With Users","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/user-management-of-portfolios/shareportfoliowithusers","deprecated":false}]}]}]}]}},{"type":"group","label":"Individual Portfolio Management","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/individual-portfolio-management","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/individual-portfolio-management","items":[{"label":"List Companies In A Portfolio","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/individual-portfolio-management/listcompaniesinaportfolio","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/individual-portfolio-management/listcompaniesinaportfolio","metadata":{"seo":{"title":"List Companies In A Portfolio","description":"This endpoints gets all companies from a specific portfolio based on the portfolio id, optionally filter with query parameters."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listCompaniesInAPortfolio","name":"List Companies In A Portfolio","isWebhook":false,"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1companies/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Companies In A Portfolio","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This endpoints gets all companies from a specific portfolio based on the portfolio id, optionally filter with query parameters."},{"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":"portfolioId","in":"path","schemaId":"schema_438","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier of the portfolio, obtained from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/portfolios"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1companies/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"searchQuery","in":"query","schemaId":"schema_387","description":"Return companies that match the given value"},{"name":"pageSize","in":"query","schemaId":"schema_388","description":"Specifies the number of items to be displayed per page. Allowed values are between 1 and 100."},{"name":"page","in":"query","schemaId":"schema_437","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Starting page number inGlobal Monitoring is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If all items are displayed on one page this can also be left blank."},"children":[]}]}]}]},{"name":"countryCode","in":"query","schemaId":"schema_387","description":"Return companies from the portfolio that match the given countryCode"}],"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1companies/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/monitoring/portfolios/{portfolioId}/companies","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"portfolioId","in":"path","required":true,"schemaId":"schema_438"}],"query":[{"name":"searchQuery","in":"query","schemaId":"schema_387"},{"name":"pageSize","in":"query","schemaId":"schema_388"},{"name":"page","in":"query","schemaId":"schema_437"},{"name":"countryCode","in":"query","schemaId":"schema_387"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/monitoring/portfolios/{portfolioId}/companies","href":"individual-portfolio-management/listcompaniesinaportfolio","openApiOperationId":"listCompaniesInAPortfolio","summary":"List Companies In A Portfolio"},"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/ConnectMonitoringCompaniesInAPortfolio"}},"schemaId":"components/schemas/ConnectMonitoringCompaniesInAPortfolio"},{"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/~1monitoring~1portfolios~1{portfolioId}~1companies/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConnectMonitoringCompaniesInAPortfolio","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringCompaniesInAPortfolio"}}},{"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":"/individual-portfolio-management/listcompaniesinaportfolio"}],"panels":[]}]},"httpPath":"/monitoring/portfolios/{portfolioId}/companies"},{"label":"Add Company To Portfolio","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/individual-portfolio-management/addcompanytoportfolio","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/individual-portfolio-management/addcompanytoportfolio","metadata":{"seo":{"title":"Add Company To Portfolio","description":"Endpoint to add a company using a company id, into a portfolio provided in as a path parameter. Additional fields can be used to add a personalReference, freeText, and personalLimit. These fields need to be submitted in the requestBody but can be 'nulled' if not required. See the two examples of the submission with and without these fields."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"addCompanyToPortfolio","name":"Add Company To Portfolio","isWebhook":false,"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1companies/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add Company To Portfolio","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Endpoint to add a company using a company id, into a portfolio provided in as a path parameter. Additional fields can be used to add a personalReference, freeText, and personalLimit. These fields need to be submitted in the requestBody but can be 'nulled' if not required. See the two examples of the submission with and without these fields."},{"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":"portfolioId","in":"path","schemaId":"schema_438","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier of the portfolio, obtained from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/portfolios"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1companies/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringAddCompanyToPortfolioRequest","exampleIds":["paths/~1monitoring~1portfolios~1{portfolioId}~1companies/post/requestBody/content/application~1json/examples/id only","paths/~1monitoring~1portfolios~1{portfolioId}~1companies/post/requestBody/content/application~1json/examples/All Fields"]}},"schemaId":"components/schemas/ConnectMonitoringAddCompanyToPortfolioRequest","exampleIds":["paths/~1monitoring~1portfolios~1{portfolioId}~1companies/post/requestBody/content/application~1json/examples/id only","paths/~1monitoring~1portfolios~1{portfolioId}~1companies/post/requestBody/content/application~1json/examples/All Fields"],"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1companies/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/monitoring/portfolios/{portfolioId}/companies","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"portfolioId","in":"path","required":true,"schemaId":"schema_438"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringAddCompanyToPortfolioRequest","exampleIds":["paths/~1monitoring~1portfolios~1{portfolioId}~1companies/post/requestBody/content/application~1json/examples/id only","paths/~1monitoring~1portfolios~1{portfolioId}~1companies/post/requestBody/content/application~1json/examples/All Fields"]}},"responseCodes":["200","400","401","403","404","409"],"pointer":"/monitoring/portfolios/{portfolioId}/companies","href":"individual-portfolio-management/addcompanytoportfolio","openApiOperationId":"addCompanyToPortfolio","summary":"Add Company To Portfolio"},"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/ConnectMonitoringAddCompanyToPortfolioRequest","exampleIds":["paths/~1monitoring~1portfolios~1{portfolioId}~1companies/post/requestBody/content/application~1json/examples/id only","paths/~1monitoring~1portfolios~1{portfolioId}~1companies/post/requestBody/content/application~1json/examples/All Fields"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringAddCompanyToPortfolioRequest","exampleIds":["paths/~1monitoring~1portfolios~1{portfolioId}~1companies/post/requestBody/content/application~1json/examples/id only","paths/~1monitoring~1portfolios~1{portfolioId}~1companies/post/requestBody/content/application~1json/examples/All Fields"]}},"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/ConnectMonitoringAddCompanyToPortfolioResponse"}},"schemaId":"components/schemas/ConnectMonitoringAddCompanyToPortfolioResponse"},{"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":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}],"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1companies/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConnectMonitoringAddCompanyToPortfolioResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringAddCompanyToPortfolioResponse"}}},{"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":"409","schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/individual-portfolio-management/addcompanytoportfolio"}],"panels":[]}]},"httpPath":"/monitoring/portfolios/{portfolioId}/companies"},{"label":"Get Company Details From A Portfolio","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/individual-portfolio-management/getcompanydetailsfromaportfolio","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/individual-portfolio-management/getcompanydetailsfromaportfolio","metadata":{"seo":{"title":"Get Company Details From A Portfolio","description":"This endpoint allows you to get various company details from a portfolio. Requires a portfolioID and companyID in the PATH of the request."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCompanyDetailsFromAPortfolio","name":"Get Company Details From A Portfolio","isWebhook":false,"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1companies~1{companyId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Company Details From A Portfolio","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This endpoint allows you to get various company details from a portfolio. Requires a portfolioID and companyID in the PATH of the request."},{"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":"portfolioId","in":"path","schemaId":"schema_438","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier of the portfolio, obtained from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/portfolios"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"companyId","in":"path","schemaId":"schema_387","description":"A company Safe Number or Connect ID.","required":true}],"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1companies~1{companyId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/monitoring/portfolios/{portfolioId}/companies/{companyId}","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"portfolioId","in":"path","required":true,"schemaId":"schema_438"},{"name":"companyId","in":"path","required":true,"schemaId":"schema_387"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/monitoring/portfolios/{portfolioId}/companies/{companyId}","href":"individual-portfolio-management/getcompanydetailsfromaportfolio","openApiOperationId":"getCompanyDetailsFromAPortfolio","summary":"Get Company Details From A Portfolio"},"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/ConnectMonitoringGetCompanyFromPortfolio"}},"schemaId":"components/schemas/ConnectMonitoringGetCompanyFromPortfolio"},{"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/~1monitoring~1portfolios~1{portfolioId}~1companies~1{companyId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConnectMonitoringGetCompanyFromPortfolio","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringGetCompanyFromPortfolio"}}},{"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":"/individual-portfolio-management/getcompanydetailsfromaportfolio"}],"panels":[]}]},"httpPath":"/monitoring/portfolios/{portfolioId}/companies/{companyId}"},{"label":"Delete Company From Portfolio","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/individual-portfolio-management/deletecompanyfromportfolio","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/individual-portfolio-management/deletecompanyfromportfolio","metadata":{"seo":{"title":"Delete Company From Portfolio","description":"Endpoint to delete a company from a portfolio."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteCompanyFromPortfolio","name":"Delete Company From Portfolio","isWebhook":false,"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1companies~1{companyId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Company From Portfolio","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Endpoint to delete a company from a portfolio."},{"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":"portfolioId","in":"path","schemaId":"schema_438","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier of the portfolio, obtained from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/portfolios"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"companyId","in":"path","schemaId":"schema_387","description":"A company Safe Number or Connect ID.","required":true}],"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1companies~1{companyId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/monitoring/portfolios/{portfolioId}/companies/{companyId}","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"portfolioId","in":"path","required":true,"schemaId":"schema_438"},{"name":"companyId","in":"path","required":true,"schemaId":"schema_387"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/monitoring/portfolios/{portfolioId}/companies/{companyId}","href":"individual-portfolio-management/deletecompanyfromportfolio","openApiOperationId":"deleteCompanyFromPortfolio","summary":"Delete Company From Portfolio"},"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/ConnectMonitoringDeleteCompanyFromPortfolio"}},"schemaId":"components/schemas/ConnectMonitoringDeleteCompanyFromPortfolio"},{"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/~1monitoring~1portfolios~1{portfolioId}~1companies~1{companyId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConnectMonitoringDeleteCompanyFromPortfolio","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringDeleteCompanyFromPortfolio"}}},{"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":"/individual-portfolio-management/deletecompanyfromportfolio"}],"panels":[]}]},"httpPath":"/monitoring/portfolios/{portfolioId}/companies/{companyId}"},{"label":"Update Company Details In Portfolio","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/individual-portfolio-management/updatecompanydetailsinportfolio","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/individual-portfolio-management/updatecompanydetailsinportfolio","metadata":{"seo":{"title":"Update Company Details In Portfolio","description":"Updates the company details in a specified portfolio."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateCompanyDetailsInPortfolio","name":"Update Company Details In Portfolio","isWebhook":false,"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1companies~1{companyId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Company Details In Portfolio","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates the company details in a specified portfolio."},{"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":"portfolioId","in":"path","schemaId":"schema_438","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier of the portfolio, obtained from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/portfolios"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"companyId","in":"path","schemaId":"schema_387","description":"A company Safe Number or Connect ID.","required":true}],"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1companies~1{companyId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringUpdateCompanyDetailsInPortfolioRequest","exampleIds":["paths/~1monitoring~1portfolios~1{portfolioId}~1companies~1{companyId}/patch/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/ConnectMonitoringUpdateCompanyDetailsInPortfolioRequest","exampleIds":["paths/~1monitoring~1portfolios~1{portfolioId}~1companies~1{companyId}/patch/requestBody/content/application~1json/example"],"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1companies~1{companyId}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/monitoring/portfolios/{portfolioId}/companies/{companyId}","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"portfolioId","in":"path","required":true,"schemaId":"schema_438"},{"name":"companyId","in":"path","required":true,"schemaId":"schema_387"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringUpdateCompanyDetailsInPortfolioRequest","exampleIds":["paths/~1monitoring~1portfolios~1{portfolioId}~1companies~1{companyId}/patch/requestBody/content/application~1json/example"]}},"responseCodes":["200","204","400","401","403","404"],"pointer":"/monitoring/portfolios/{portfolioId}/companies/{companyId}","href":"individual-portfolio-management/updatecompanydetailsinportfolio","openApiOperationId":"updateCompanyDetailsInPortfolio","summary":"Update Company Details In Portfolio"},"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/ConnectMonitoringUpdateCompanyDetailsInPortfolioRequest","exampleIds":["paths/~1monitoring~1portfolios~1{portfolioId}~1companies~1{companyId}/patch/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringUpdateCompanyDetailsInPortfolioRequest","exampleIds":["paths/~1monitoring~1portfolios~1{portfolioId}~1companies~1{companyId}/patch/requestBody/content/application~1json/example"]}},"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/ConnectMonitoringUpdateCompanyInPortfolio"}},"schemaId":"components/schemas/ConnectMonitoringUpdateCompanyInPortfolio"},{"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/~1monitoring~1portfolios~1{portfolioId}~1companies~1{companyId}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConnectMonitoringUpdateCompanyInPortfolio","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringUpdateCompanyInPortfolio"}}},{"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":"/individual-portfolio-management/updatecompanydetailsinportfolio"}],"panels":[]}]},"httpPath":"/monitoring/portfolios/{portfolioId}/companies/{companyId}"},{"label":"Return Company Specific Notification Events","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/individual-portfolio-management/listcompanyspecificnotificationevents","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/individual-portfolio-management/listcompanyspecificnotificationevents","metadata":{"seo":{"title":"Return Company Specific Notification Events","description":"List of notification events based on the company id,optionally filtered with query parameters."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listCompanySpecificNotificationEvents","name":"Return Company Specific Notification Events","isWebhook":false,"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1companies~1{companyId}~1notificationEvents/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return Company Specific Notification Events","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List of notification events based on the company id,optionally filtered with query parameters."},{"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":"portfolioId","in":"path","schemaId":"schema_387","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier of the portfolio, obtained from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/portfolios"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"companyId","in":"path","schemaId":"schema_387","description":"A company Safe Number or Connect ID.","required":true}],"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1companies~1{companyId}~1notificationEvents/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"searchQuery","in":"query","schemaId":"schema_387","description":"Return notificationEvents that match the given value"},{"name":"sortDir","in":"query","schemaId":"schema_389","description":"The direction that you wish to sort results by."},{"name":"pageSize","in":"query","schemaId":"schema_440","description":"Number of items to return per Page (max 1000)"},{"name":"page","in":"query","schemaId":"schema_437","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Starting page number inGlobal Monitoring is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If all items are displayed on one page this can also be left blank."},"children":[]}]}]}]},{"name":"isProcessed","in":"query","schemaId":"schema_441","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" flag for each event to indicate whether the system has performed an action on the notification."},"children":[]}]}]}]},{"name":"sortBy","in":"query","schemaId":"schema_442","description":"Sort results by this column. Null values of sort column are listed after non-nulls."}],"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1companies~1{companyId}~1notificationEvents/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/monitoring/portfolios/{portfolioId}/companies/{companyId}/notificationEvents","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"portfolioId","in":"path","required":true,"schemaId":"schema_387"},{"name":"companyId","in":"path","required":true,"schemaId":"schema_387"}],"query":[{"name":"searchQuery","in":"query","schemaId":"schema_387"},{"name":"sortDir","in":"query","schemaId":"schema_389"},{"name":"pageSize","in":"query","schemaId":"schema_440"},{"name":"page","in":"query","schemaId":"schema_437"},{"name":"isProcessed","in":"query","schemaId":"schema_441"},{"name":"sortBy","in":"query","schemaId":"schema_442"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","400","401","403","404"],"pointer":"/monitoring/portfolios/{portfolioId}/companies/{companyId}/notificationEvents","href":"individual-portfolio-management/listcompanyspecificnotificationevents","openApiOperationId":"listCompanySpecificNotificationEvents","summary":"Return Company Specific Notification Events"},"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":"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/~1monitoring~1portfolios~1{portfolioId}~1companies~1{companyId}~1notificationEvents/get/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":"/individual-portfolio-management/listcompanyspecificnotificationevents"}],"panels":[]}]},"httpPath":"/monitoring/portfolios/{portfolioId}/companies/{companyId}/notificationEvents"},{"label":"Clear Companies From Portfolio","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/individual-portfolio-management/clearcompaniesfromportfolio","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/individual-portfolio-management/clearcompaniesfromportfolio","metadata":{"seo":{"title":"Clear Companies From Portfolio","description":"This endpoint allows for companies to be deleted from the specified portfolio."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"clearCompaniesFromPortfolio","name":"Clear Companies From Portfolio","isWebhook":false,"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1companies~1clear/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Clear Companies From Portfolio","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This endpoint allows for companies to be deleted from the specified portfolio."},{"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":"portfolioId","in":"path","schemaId":"schema_438","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier of the portfolio you want to delete companies from, obtained from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/portfolios"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1companies~1clear/patch/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"clearAll","in":"query","schemaId":"schema_392","description":"When ClearAll query parameter is False,Companies List needs to be passed. When ClearAll query parameter is True, Companies List must be empty. All companies will be deleted"}],"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1companies~1clear/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringClearCompaniesRequest","exampleIds":["paths/~1monitoring~1portfolios~1{portfolioId}~1companies~1clear/patch/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/ConnectMonitoringClearCompaniesRequest","exampleIds":["paths/~1monitoring~1portfolios~1{portfolioId}~1companies~1clear/patch/requestBody/content/application~1json/example"],"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1companies~1clear/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/monitoring/portfolios/{portfolioId}/companies/clear","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"portfolioId","in":"path","required":true,"schemaId":"schema_438"}],"query":[{"name":"clearAll","in":"query","schemaId":"schema_392"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringClearCompaniesRequest","exampleIds":["paths/~1monitoring~1portfolios~1{portfolioId}~1companies~1clear/patch/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","403","404"],"pointer":"/monitoring/portfolios/{portfolioId}/companies/clear","href":"individual-portfolio-management/clearcompaniesfromportfolio","openApiOperationId":"clearCompaniesFromPortfolio","summary":"Clear Companies From Portfolio"},"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/ConnectMonitoringClearCompaniesRequest","exampleIds":["paths/~1monitoring~1portfolios~1{portfolioId}~1companies~1clear/patch/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringClearCompaniesRequest","exampleIds":["paths/~1monitoring~1portfolios~1{portfolioId}~1companies~1clear/patch/requestBody/content/application~1json/example"]}},"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/ConnectMonitoringClearCompaniesResponse"}},"schemaId":"components/schemas/ConnectMonitoringClearCompaniesResponse"},{"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/~1monitoring~1portfolios~1{portfolioId}~1companies~1clear/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConnectMonitoringClearCompaniesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringClearCompaniesResponse"}}},{"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":"/individual-portfolio-management/clearcompaniesfromportfolio"}],"panels":[]}]},"httpPath":"/monitoring/portfolios/{portfolioId}/companies/clear"},{"label":"List Countries of Monitored Companies","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/individual-portfolio-management/listcountriesofmonitoredcompanies","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/individual-portfolio-management/listcountriesofmonitoredcompanies","metadata":{"seo":{"title":"List Countries of Monitored Companies","description":"This endpoint provides a list of distinct countries associated with the companies monitored within a specific portfolio."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listCountriesOfMonitoredCompanies","name":"List Countries of Monitored Companies","isWebhook":false,"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1countries/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Countries of Monitored Companies","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This endpoint provides a list of distinct countries associated with the companies monitored within a specific portfolio."},{"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":"portfolioId","in":"path","schemaId":"schema_438","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier of the portfolio, obtained from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/portfolios"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1countries/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/monitoring/portfolios/{portfolioId}/countries","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"portfolioId","in":"path","required":true,"schemaId":"schema_438"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/monitoring/portfolios/{portfolioId}/countries","href":"individual-portfolio-management/listcountriesofmonitoredcompanies","openApiOperationId":"listCountriesOfMonitoredCompanies","summary":"List Countries of Monitored Companies"},"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/ConnectMonitoringMonitoredCountriesInPortfolio"}},"schemaId":"components/schemas/ConnectMonitoringMonitoredCountriesInPortfolio"},{"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/~1monitoring~1portfolios~1{portfolioId}~1countries/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConnectMonitoringMonitoredCountriesInPortfolio","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringMonitoredCountriesInPortfolio"}}},{"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":"/individual-portfolio-management/listcountriesofmonitoredcompanies"}],"panels":[]}]},"httpPath":"/monitoring/portfolios/{portfolioId}/countries"},{"label":"List Portfolio Event Rules","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/individual-portfolio-management/listportfolioeventrules","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/individual-portfolio-management/listportfolioeventrules","metadata":{"seo":{"title":"List Portfolio Event Rules","description":"Get all notification eventRules for the given portfolioId. Notification event rules allow you to control which events you wish to monitor for the companies contained within the given portfolio."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listPortfolioEventRules","name":"List Portfolio Event Rules","isWebhook":false,"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1eventRules/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Portfolio Event Rules","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":"Get all notification "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eventRules"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the given "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"portfolioId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Notification event rules allow you to control which events you wish to monitor for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"companies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contained within the given "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"portfolio"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API requires authentication for access to protected endpoints. Authentication is performed by providing a valid JWT token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"portfolioId","in":"path","schemaId":"schema_438","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier for the portfolio that you wish to retrieve notification event rules for, obtained from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/portfolios"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1eventRules/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/monitoring/portfolios/{portfolioId}/eventRules","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"portfolioId","in":"path","required":true,"schemaId":"schema_438"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/monitoring/portfolios/{portfolioId}/eventRules","href":"individual-portfolio-management/listportfolioeventrules","openApiOperationId":"listPortfolioEventRules","summary":"List Portfolio Event Rules"},"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/ConnectMonitoringListPortfolioEventRules"}},"schemaId":"components/schemas/ConnectMonitoringListPortfolioEventRules"},{"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/~1monitoring~1portfolios~1{portfolioId}~1eventRules/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConnectMonitoringListPortfolioEventRules","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringListPortfolioEventRules"}}},{"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":"/individual-portfolio-management/listportfolioeventrules"}],"panels":[]}]},"httpPath":"/monitoring/portfolios/{portfolioId}/eventRules"},{"label":"List Portfolio Event Rules By Country","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/individual-portfolio-management/listportfolioeventrulesbycountry","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/individual-portfolio-management/listportfolioeventrulesbycountry","metadata":{"seo":{"title":"List Portfolio Event Rules By Country","description":"Endpoint that lists all the eventRules, their status, and parameters based on a portfolio Id, filtered by country. Newly created portfolios are without any notification event rules by default, but you can switch rules on/off per country or on a global basis. There are different rules available for each country due to the different type of change event data that's available. The following GET request lists all the available rules for a portfolio. For guidance on how to use event rules with PARAM prefixes and to understand rule parameters, see the documentation here: Special Event Rules. For example, global rule 101 may require specific PARAM values as described in the linked documentation."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listPortfolioEventRulesByCountry","name":"List Portfolio Event Rules By Country","isWebhook":false,"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1eventRules~1{countryCode}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Portfolio Event Rules By Country","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 that lists all the eventRules, their status, and parameters based on a portfolio Id, filtered by country. Newly created portfolios are without any notification event rules by default, but you can switch rules on/off per country or on a global basis. There are different rules available for each country due to the different type of change event data that's available. The following GET request lists all the available rules for a portfolio."},"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":" For guidance on how to use event rules with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PARAM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" prefixes and to understand rule parameters, see the documentation here: "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://doc.creditsafe.com/connect-apis-catalog/product-catalog/globalmonitoring/documentation/specialeventrules"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Special Event Rules"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For example, global rule 101 may require specific PARAM values as described in the linked documentation."},"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":"portfolioId","in":"path","schemaId":"schema_438","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier of the portfolio, obtained from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/portfolios"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"countryCode","in":"path","schemaId":"schema_404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Country code to show events for. "},"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 there is one exception in that "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PLC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the only 3-character that can be accepted here."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1eventRules~1{countryCode}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/monitoring/portfolios/{portfolioId}/eventRules/{countryCode}","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"portfolioId","in":"path","required":true,"schemaId":"schema_438"},{"name":"countryCode","in":"path","required":true,"schemaId":"schema_404"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/monitoring/portfolios/{portfolioId}/eventRules/{countryCode}","href":"individual-portfolio-management/listportfolioeventrulesbycountry","openApiOperationId":"listPortfolioEventRulesByCountry","summary":"List Portfolio Event Rules By Country"},"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/ConnectMonitoringListPortfolioEventRules"}},"schemaId":"components/schemas/ConnectMonitoringListPortfolioEventRules"},{"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/~1monitoring~1portfolios~1{portfolioId}~1eventRules~1{countryCode}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConnectMonitoringListPortfolioEventRules","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringListPortfolioEventRules"}}},{"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":"/individual-portfolio-management/listportfolioeventrulesbycountry"}],"panels":[]}]},"httpPath":"/monitoring/portfolios/{portfolioId}/eventRules/{countryCode}"},{"label":"Update EventRules","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/individual-portfolio-management/updateeventrules","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/individual-portfolio-management/updateeventrules","metadata":{"seo":{"title":"Update EventRules","description":"Endpoint to update an eventRule in a portfolio. Must provide a portfolio unique identifier and a country code in the URL of the PUT request. The Body of the request must contain the ruleCode number of the eventRule you want to update, with an isActive parameter. Some event rules may also contain specific parameters, which can be set with param0, param1 and param2. For example, global rule 101 may require specific PARAM values as described in the Special Event Rules documentation. Get the above information by calling the List All eventRules endpoint. Important Note It is recommended that any changes made to the Event Rules are verified using the List Portfolio Event Rules Endpoint after the PUT call has been made."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateEventRules","name":"Update EventRules","isWebhook":false,"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1eventRules~1{countryCode}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update EventRules","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 update an eventRule in a portfolio. Must provide a portfolio unique identifier and a country code in the URL of the PUT request. The Body of the request must contain the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ruleCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" number of the eventRule you want to update, with an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isActive"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter. Some event rules may also contain specific parameters, which can be set with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"param0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"param1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"param2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For example, global rule 101 may require specific PARAM values as described in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://doc.creditsafe.com/connect-apis-catalog/product-catalog/globalmonitoring/documentation/specialeventrules"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Special Event Rules documentation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Get the above information by calling the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://doc.creditsafe.com/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/individual-portfolio-management/listportfolioeventrules"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List All eventRules endpoint"},"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":"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":"Important Note"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" It is recommended that any changes made to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Event Rules"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are verified using the List Portfolio Event Rules Endpoint after the PUT call has been made."},"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":"portfolioId","in":"path","schemaId":"schema_438","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier of the portfolio, obtained from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/portfolios"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"countryCode","in":"path","schemaId":"schema_404","description":"Country code to show events for","required":true}],"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1eventRules~1{countryCode}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringUpdateEventRulesRequest","exampleIds":["paths/~1monitoring~1portfolios~1{portfolioId}~1eventRules~1{countryCode}/put/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/ConnectMonitoringUpdateEventRulesRequest","exampleIds":["paths/~1monitoring~1portfolios~1{portfolioId}~1eventRules~1{countryCode}/put/requestBody/content/application~1json/example"],"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1eventRules~1{countryCode}/put/requestBody","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To ensure optimal processing efficiency when updating live event rules—whether for removal, addition, or status change—it is best practice to update the entire list of rules in a single operation. Some rules, such as global rule 101, require specific PARAM values. Please refer to the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://doc.creditsafe.com/connect-apis-catalog/product-catalog/globalmonitoring/documentation/specialeventrules"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Special Event Rules documentation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for guidance on correct parameter usage."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/monitoring/portfolios/{portfolioId}/eventRules/{countryCode}","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"portfolioId","in":"path","required":true,"schemaId":"schema_438"},{"name":"countryCode","in":"path","required":true,"schemaId":"schema_404"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringUpdateEventRulesRequest","exampleIds":["paths/~1monitoring~1portfolios~1{portfolioId}~1eventRules~1{countryCode}/put/requestBody/content/application~1json/example"]}},"responseCodes":["204","400","401","403","404"],"pointer":"/monitoring/portfolios/{portfolioId}/eventRules/{countryCode}","href":"individual-portfolio-management/updateeventrules","openApiOperationId":"updateEventRules","summary":"Update EventRules"},"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/ConnectMonitoringUpdateEventRulesRequest","exampleIds":["paths/~1monitoring~1portfolios~1{portfolioId}~1eventRules~1{countryCode}/put/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringUpdateEventRulesRequest","exampleIds":["paths/~1monitoring~1portfolios~1{portfolioId}~1eventRules~1{countryCode}/put/requestBody/content/application~1json/example"]}},"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","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_439"}},"schemaId":"schema_439"},{"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/~1monitoring~1portfolios~1{portfolioId}~1eventRules~1{countryCode}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204","schemaId":"schema_439","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_439"}}},{"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":"/individual-portfolio-management/updateeventrules"}],"panels":[]}]},"httpPath":"/monitoring/portfolios/{portfolioId}/eventRules/{countryCode}"},{"label":"Set Portfolio Default Rules","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/individual-portfolio-management/setportfoliodefaultrules","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/individual-portfolio-management/setportfoliodefaultrules","metadata":{"seo":{"title":"Set Portfolio Default Rules","description":"Update a portfolios event rules to default state. In Connect, default state means all rules are turned off."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"setPortfolioDefaultRules","name":"Set Portfolio Default Rules","isWebhook":false,"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1eventRules~1setDefault/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Set Portfolio Default Rules","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update a portfolios event rules to default state. In Connect, default state means all rules are turned off."},{"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":"portfolioId","in":"path","schemaId":"schema_438","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier of the portfolio, obtained from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/portfolios"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1eventRules~1setDefault/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/monitoring/portfolios/{portfolioId}/eventRules/setDefault","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"portfolioId","in":"path","required":true,"schemaId":"schema_438"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","400","401","403","404"],"pointer":"/monitoring/portfolios/{portfolioId}/eventRules/setDefault","href":"individual-portfolio-management/setportfoliodefaultrules","openApiOperationId":"setPortfolioDefaultRules","summary":"Set Portfolio Default Rules"},"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":"204","description":"No Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_439"}},"schemaId":"schema_439"},{"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/~1monitoring~1portfolios~1{portfolioId}~1eventRules~1setDefault/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204","schemaId":"schema_439","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_439"}}},{"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":"/individual-portfolio-management/setportfoliodefaultrules"}],"panels":[]}]},"httpPath":"/monitoring/portfolios/{portfolioId}/eventRules/setDefault"},{"label":"List Portfolio Notifications","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/individual-portfolio-management/listportfolionotifications","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/individual-portfolio-management/listportfolionotifications","metadata":{"seo":{"title":"List Portfolio Notifications","description":"Get all notificationEvents based on the portfolio id, optionally filter with query parameters."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listPortfolioNotifications","name":"List Portfolio Notifications","isWebhook":false,"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1notificationEvents/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Portfolio Notifications","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get all notificationEvents based on the portfolio id, optionally filter with query parameters."},{"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":"portfolioId","in":"path","schemaId":"schema_438","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier of the portfolio, obtained from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/portfolios"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1notificationEvents/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"searchQuery","in":"query","schemaId":"schema_387","description":"Return notificationEvents that match the given value"},{"name":"sortBy","in":"query","schemaId":"schema_443","description":"Sort results by this column. Null values of sort column are listed after non-nulls."},{"name":"sortDir","in":"query","schemaId":"schema_389","description":"The direction that you wish to sort results by."},{"name":"pageSize","in":"query","schemaId":"schema_388","description":"Specifies the number of items to be displayed per page. Allowed values are between 1 and 100."},{"name":"page","in":"query","schemaId":"schema_437","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Starting page number inGlobal Monitoring is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If all items are displayed on one page this can also be left blank."},"children":[]}]}]}]},{"name":"startDate","in":"query","schemaId":"schema_397","description":"The start date on which results are filtered."},{"name":"endDate","in":"query","schemaId":"schema_397","description":"The end date on which results are filtered."},{"name":"filterByCreatedDate","in":"query","schemaId":"schema_444","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to filter the Notification Events of the \"createdDate\" field when using "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameters. By default this is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", with the date parameters filtering using the \"eventDate\" field."},"children":[]}]}]}]}],"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1notificationEvents/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/monitoring/portfolios/{portfolioId}/notificationEvents","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"portfolioId","in":"path","required":true,"schemaId":"schema_438"}],"query":[{"name":"searchQuery","in":"query","schemaId":"schema_387"},{"name":"sortBy","in":"query","schemaId":"schema_443"},{"name":"sortDir","in":"query","schemaId":"schema_389"},{"name":"pageSize","in":"query","schemaId":"schema_388"},{"name":"page","in":"query","schemaId":"schema_437"},{"name":"startDate","in":"query","schemaId":"schema_397"},{"name":"endDate","in":"query","schemaId":"schema_397"},{"name":"filterByCreatedDate","in":"query","schemaId":"schema_444"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/monitoring/portfolios/{portfolioId}/notificationEvents","href":"individual-portfolio-management/listportfolionotifications","openApiOperationId":"listPortfolioNotifications","summary":"List Portfolio Notifications"},"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/ConnectMonitoringAllNotificationsEvents"}},"schemaId":"components/schemas/ConnectMonitoringAllNotificationsEvents"},{"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/~1monitoring~1portfolios~1{portfolioId}~1notificationEvents/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConnectMonitoringAllNotificationsEvents","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringAllNotificationsEvents"}}},{"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":"/individual-portfolio-management/listportfolionotifications"}],"panels":[]}]},"httpPath":"/monitoring/portfolios/{portfolioId}/notificationEvents"},{"label":"Return Monitoring Portfolios Notification Events Data By Day","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/individual-portfolio-management/portfolioidnotificationeventsdatabyday","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/individual-portfolio-management/portfolioidnotificationeventsdatabyday","metadata":{"seo":{"title":"Return Monitoring Portfolios Notification Events Data By Day","description":"WARNING - This endpoint returns daily event totals for the given range."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"portfolioIdNotificationEventsDataByDay","name":"Return Monitoring Portfolios Notification Events Data By Day","isWebhook":false,"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1notificationEvents~1dataByDay/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return Monitoring Portfolios Notification Events Data By Day","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"WARNING -  This endpoint returns daily event totals for the given range."},{"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":"portfolioId","in":"path","schemaId":"schema_438","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier of the portfolio, obtained from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/portfolios"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1notificationEvents~1dataByDay/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"startDate","in":"query","schemaId":"schema_397","description":"The start date on which results are filtered.","required":true},{"name":"endDate","in":"query","schemaId":"schema_397","description":"The end date on which results are filtered.","required":true}],"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1notificationEvents~1dataByDay/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/monitoring/portfolios/{portfolioId}/notificationEvents/dataByDay","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"portfolioId","in":"path","required":true,"schemaId":"schema_438"}],"query":[{"name":"startDate","in":"query","required":true,"schemaId":"schema_397"},{"name":"endDate","in":"query","required":true,"schemaId":"schema_397"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/monitoring/portfolios/{portfolioId}/notificationEvents/dataByDay","href":"individual-portfolio-management/portfolioidnotificationeventsdatabyday","openApiOperationId":"portfolioIdNotificationEventsDataByDay","summary":"Return Monitoring Portfolios Notification Events Data By Day"},"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/ConnectMonitoringNotificationsEventsDataByDay"}},"schemaId":"components/schemas/ConnectMonitoringNotificationsEventsDataByDay"},{"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":"schema_445"}},"schemaId":"schema_445"}],"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1notificationEvents~1dataByDay/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConnectMonitoringNotificationsEventsDataByDay","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringNotificationsEventsDataByDay"}}},{"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":"schema_445","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_445"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/individual-portfolio-management/portfolioidnotificationeventsdatabyday"}],"panels":[]}]},"httpPath":"/monitoring/portfolios/{portfolioId}/notificationEvents/dataByDay"},{"label":"Portfolio Risk Summary","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/individual-portfolio-management/portfoliorisksummary","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/individual-portfolio-management/portfoliorisksummary","metadata":{"seo":{"title":"Portfolio Risk Summary","description":"Get current portfolio risk summary information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"portfolioRiskSummary","name":"Portfolio Risk Summary","isWebhook":false,"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1riskSummary/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Portfolio Risk Summary","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get current portfolio risk summary information."},{"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":"portfolioId","in":"path","schemaId":"schema_438","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier of the portfolio, obtained from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/portfolios"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1monitoring~1portfolios~1{portfolioId}~1riskSummary/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/monitoring/portfolios/{portfolioId}/riskSummary","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"portfolioId","in":"path","required":true,"schemaId":"schema_438"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/monitoring/portfolios/{portfolioId}/riskSummary","href":"individual-portfolio-management/portfoliorisksummary","openApiOperationId":"portfolioRiskSummary","summary":"Portfolio Risk Summary"},"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/ConnectMonitoringRiskSummary"}},"schemaId":"components/schemas/ConnectMonitoringRiskSummary"},{"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/~1monitoring~1portfolios~1{portfolioId}~1riskSummary/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConnectMonitoringRiskSummary","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringRiskSummary"}}},{"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":"/individual-portfolio-management/portfoliorisksummary"}],"panels":[]}]},"httpPath":"/monitoring/portfolios/{portfolioId}/riskSummary"}],"content":{"contentType":"group","meta":{"name":"Individual Portfolio Management"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Individual Portfolio Management","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/monitoring/portfolios/{portfolioId}/companies","summary":"List Companies In A Portfolio","prefix":{"name":"get","color":"get"},"badges":[],"link":"/individual-portfolio-management/listcompaniesinaportfolio","deprecated":false},{"title":"/monitoring/portfolios/{portfolioId}/companies","summary":"Add Company To Portfolio","prefix":{"name":"post","color":"post"},"badges":[],"link":"/individual-portfolio-management/addcompanytoportfolio","deprecated":false},{"title":"/monitoring/portfolios/{portfolioId}/companies/{companyId}","summary":"Get Company Details From A Portfolio","prefix":{"name":"get","color":"get"},"badges":[],"link":"/individual-portfolio-management/getcompanydetailsfromaportfolio","deprecated":false},{"title":"/monitoring/portfolios/{portfolioId}/companies/{companyId}","summary":"Delete Company From Portfolio","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/individual-portfolio-management/deletecompanyfromportfolio","deprecated":false},{"title":"/monitoring/portfolios/{portfolioId}/companies/{companyId}","summary":"Update Company Details In Portfolio","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/individual-portfolio-management/updatecompanydetailsinportfolio","deprecated":false},{"title":"/monitoring/portfolios/{portfolioId}/companies/{companyId}/notificationEvents","summary":"Return Company Specific Notification Events","prefix":{"name":"get","color":"get"},"badges":[],"link":"/individual-portfolio-management/listcompanyspecificnotificationevents","deprecated":false},{"title":"/monitoring/portfolios/{portfolioId}/companies/clear","summary":"Clear Companies From Portfolio","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/individual-portfolio-management/clearcompaniesfromportfolio","deprecated":false},{"title":"/monitoring/portfolios/{portfolioId}/countries","summary":"List Countries of Monitored Companies","prefix":{"name":"get","color":"get"},"badges":[],"link":"/individual-portfolio-management/listcountriesofmonitoredcompanies","deprecated":false},{"title":"/monitoring/portfolios/{portfolioId}/eventRules","summary":"List Portfolio Event Rules","prefix":{"name":"get","color":"get"},"badges":[],"link":"/individual-portfolio-management/listportfolioeventrules","deprecated":false},{"title":"/monitoring/portfolios/{portfolioId}/eventRules/{countryCode}","summary":"List Portfolio Event Rules By Country","prefix":{"name":"get","color":"get"},"badges":[],"link":"/individual-portfolio-management/listportfolioeventrulesbycountry","deprecated":false},{"title":"/monitoring/portfolios/{portfolioId}/eventRules/{countryCode}","summary":"Update EventRules","prefix":{"name":"put","color":"put"},"badges":[],"link":"/individual-portfolio-management/updateeventrules","deprecated":false},{"title":"/monitoring/portfolios/{portfolioId}/eventRules/setDefault","summary":"Set Portfolio Default Rules","prefix":{"name":"put","color":"put"},"badges":[],"link":"/individual-portfolio-management/setportfoliodefaultrules","deprecated":false},{"title":"/monitoring/portfolios/{portfolioId}/notificationEvents","summary":"List Portfolio Notifications","prefix":{"name":"get","color":"get"},"badges":[],"link":"/individual-portfolio-management/listportfolionotifications","deprecated":false},{"title":"/monitoring/portfolios/{portfolioId}/notificationEvents/dataByDay","summary":"Return Monitoring Portfolios Notification Events Data By Day","prefix":{"name":"get","color":"get"},"badges":[],"link":"/individual-portfolio-management/portfolioidnotificationeventsdatabyday","deprecated":false},{"title":"/monitoring/portfolios/{portfolioId}/riskSummary","summary":"Portfolio Risk Summary","prefix":{"name":"get","color":"get"},"badges":[],"link":"/individual-portfolio-management/portfoliorisksummary","deprecated":false}]}]}]}]}},{"type":"group","label":"Event Rules and Notifications","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/event-rules-and-notifications","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/event-rules-and-notifications","items":[{"label":"List Company Events","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/event-rules-and-notifications/listcompanyevents","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/event-rules-and-notifications/listcompanyevents","metadata":{"seo":{"title":"List Company Events","description":"Endpoint to return a collection of events for the given company, optionally filtered on the supplied search criteria. Event information will only be returned if the company exists in at least one of your portfolios."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listCompanyEvents","name":"List Company Events","isWebhook":false,"pointer":"/paths/~1monitoring~1companies~1{id}~1events/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Company Events","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 return a collection of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"events"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the given company, optionally filtered on the supplied search criteria. Event information will only be returned if the company exists in at least one of your "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"portfolios"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API requires authentication for access to protected endpoints. Authentication is performed by providing a valid JWT token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_387","description":"The connectId of the company that you wish to retrieve events for.","required":true}],"pointer":"/paths/~1monitoring~1companies~1{id}~1events/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"startDate","in":"query","schemaId":"schema_397","description":"The start date on which results are filtered."},{"name":"endDate","in":"query","schemaId":"schema_397","description":"The end date on which results are filtered."},{"name":"page","in":"query","schemaId":"schema_437","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Starting page number inGlobal Monitoring is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If all items are displayed on one page this can also be left blank."},"children":[]}]}]}]},{"name":"pageSize","in":"query","schemaId":"schema_388","description":"Specifies the number of items to be displayed per page. Allowed values are between 1 and 100."}],"pointer":"/paths/~1monitoring~1companies~1{id}~1events/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/monitoring/companies/{id}/events","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_387"}],"query":[{"name":"startDate","in":"query","schemaId":"schema_397"},{"name":"endDate","in":"query","schemaId":"schema_397"},{"name":"page","in":"query","schemaId":"schema_437"},{"name":"pageSize","in":"query","schemaId":"schema_388"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/monitoring/companies/{id}/events","href":"event-rules-and-notifications/listcompanyevents","openApiOperationId":"listCompanyEvents","summary":"List Company Events"},"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/ConnectMonitoringCompanyEvents"}},"schemaId":"components/schemas/ConnectMonitoringCompanyEvents"},{"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/~1monitoring~1companies~1{id}~1events/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConnectMonitoringCompanyEvents","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringCompanyEvents"}}},{"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":"/event-rules-and-notifications/listcompanyevents"}],"panels":[]}]},"httpPath":"/monitoring/companies/{id}/events"},{"label":"All EventRules","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/event-rules-and-notifications/alleventrules","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/event-rules-and-notifications/alleventrules","metadata":{"seo":{"title":"All EventRules","description":"Get all available notification event rules.  Notification event rules allow you to control which events you wish to monitor for the companies contained within a given portfolio.This endpoint returns all available notification event rules, including those that are not currently enabled for the specified portfolio.  To view only the notification event rules that are currently available for a portfolio you have please use the Endpoint Portfolio Event Rules."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"allEventRules","name":"All EventRules","isWebhook":false,"pointer":"/paths/~1monitoring~1eventRules/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"All EventRules","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":"Get all available notification event rules. "},"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":" Notification event rules allow you to control which events you wish to monitor for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"companies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contained within a given "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"portfolio"},"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":"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":"This endpoint returns all available notification event rules, including those that are not currently enabled for the specified portfolio.  To view only the notification event rules that are currently available for a portfolio you have please use the Endpoint "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"doc.creditsafe.com/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/individual-portfolio-management/listportfolioeventrules"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Portfolio Event Rules"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API requires authentication for access to protected endpoints. Authentication is performed by providing a valid JWT token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/monitoring/eventRules","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","404"],"pointer":"/monitoring/eventRules","href":"event-rules-and-notifications/alleventrules","openApiOperationId":"allEventRules","summary":"All EventRules"},"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/ConnectMonitoringEventRulesResponse"}},"schemaId":"components/schemas/ConnectMonitoringEventRulesResponse"},{"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/~1monitoring~1eventRules/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConnectMonitoringEventRulesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringEventRulesResponse"}}},{"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":"/event-rules-and-notifications/alleventrules"}],"panels":[]}]},"httpPath":"/monitoring/eventRules"},{"label":"Filtered EventRules","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/event-rules-and-notifications/filteredeventrules","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/event-rules-and-notifications/filteredeventrules","metadata":{"seo":{"title":"Filtered EventRules","description":"Get all available notification event rules for the given countryCode. Notification event rules allow you to control which events you wish to monitor for the companies contained within a given portfolio."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"filteredEventRules","name":"Filtered EventRules","isWebhook":false,"pointer":"/paths/~1monitoring~1eventRules~1{countryCode}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Filtered EventRules","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":"Get all available notification event rules for the given "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"countryCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Notification event rules allow you to control which events you wish to monitor for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"companies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contained within a given "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"portfolio"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API requires authentication for access to protected endpoints. Authentication is performed by providing a valid JWT token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"countryCode","in":"path","schemaId":"schema_404","description":"ISO/Alpha 2 format country code for which notification event rules will be returned.","required":true}],"pointer":"/paths/~1monitoring~1eventRules~1{countryCode}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/monitoring/eventRules/{countryCode}","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"countryCode","in":"path","required":true,"schemaId":"schema_404"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/monitoring/eventRules/{countryCode}","href":"event-rules-and-notifications/filteredeventrules","openApiOperationId":"filteredEventRules","summary":"Filtered EventRules"},"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/ConnectMonitoringEventRulesResponse"}},"schemaId":"components/schemas/ConnectMonitoringEventRulesResponse"},{"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/~1monitoring~1eventRules~1{countryCode}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConnectMonitoringEventRulesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringEventRulesResponse"}}},{"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":"/event-rules-and-notifications/filteredeventrules"}],"panels":[]}]},"httpPath":"/monitoring/eventRules/{countryCode}"},{"label":"All Notification Events","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/event-rules-and-notifications/allnotificationevents","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/event-rules-and-notifications/allnotificationevents","metadata":{"seo":{"title":"All Notification Events","description":"Get all notification events generated for companies monitored in your portfolios, based on the notification rules enabled. The notification events returned will be filtered based upon the supplied search criteria."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"allNotificationEvents","name":"All Notification Events","isWebhook":false,"pointer":"/paths/~1monitoring~1notificationEvents/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"All Notification Events","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get all notification events generated for companies monitored in your portfolios, based on the notification rules enabled. The notification events returned will be filtered based upon the supplied 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":"searchQuery","in":"query","schemaId":"schema_387","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return notification events that match the given search value across multiple fields."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The search query will filter results based on the following fields:"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Company Name"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Returns events for companies whose name contains the search value"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"Country Code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Returns events for companies in the specified country (e.g., \"GB\", \"US\")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"Event Date"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Returns events that occurred on the specified date (format: YYYY-MM-DD)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"Event ID"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Returns the specific notification event matching the provided ID"},"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":"Examples:"},"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":"Searching for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"creditsafe\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will return all notification events where the company name, country code, event date, or event ID contains \"creditsafe\""},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Searching for a specific Event ID (e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"12345\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") will return only that notification event"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Searching for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"GB\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will return notification events for companies in Great Britain"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Searching for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"2025-11-12\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will return notification events that occurred on November 12, 2025"},"children":[]}]}]}]}]},{"name":"sortBy","in":"query","schemaId":"schema_443","description":"Sort results by this column. Null values of sort column are listed after non-nulls."},{"name":"sortDir","in":"query","schemaId":"schema_389","description":"The direction that you wish to sort results by."},{"name":"startDate","in":"query","schemaId":"schema_397","description":"The start date on which results are filtered."},{"name":"endDate","in":"query","schemaId":"schema_397","description":"The end date on which results are filtered."},{"name":"page","in":"query","schemaId":"schema_437","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Starting page number inGlobal Monitoring is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If all items are displayed on one page this can also be left blank."},"children":[]}]}]}]},{"name":"pageSize","in":"query","schemaId":"schema_388","description":"Specifies the number of items to be displayed per page. Allowed values are between 1 and 100."},{"name":"filterByCreatedDate","in":"query","schemaId":"schema_444","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to filter the Notification Events of the \"createdDate\" field when using "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameters. By default this is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", with the date parameters filtering using the \"eventDate\" field."},"children":[]}]}]}]}],"pointer":"/paths/~1monitoring~1notificationEvents/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/monitoring/notificationEvents","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[],"query":[{"name":"searchQuery","in":"query","schemaId":"schema_387"},{"name":"sortBy","in":"query","schemaId":"schema_443"},{"name":"sortDir","in":"query","schemaId":"schema_389"},{"name":"startDate","in":"query","schemaId":"schema_397"},{"name":"endDate","in":"query","schemaId":"schema_397"},{"name":"page","in":"query","schemaId":"schema_437"},{"name":"pageSize","in":"query","schemaId":"schema_388"},{"name":"filterByCreatedDate","in":"query","schemaId":"schema_444"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/monitoring/notificationEvents","href":"event-rules-and-notifications/allnotificationevents","openApiOperationId":"allNotificationEvents","summary":"All Notification Events"},"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/ConnectMonitoringAllNotificationsEvents"}},"schemaId":"components/schemas/ConnectMonitoringAllNotificationsEvents"},{"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/~1monitoring~1notificationEvents/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConnectMonitoringAllNotificationsEvents","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectMonitoringAllNotificationsEvents"}}},{"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":"/event-rules-and-notifications/allnotificationevents"}],"panels":[]}]},"httpPath":"/monitoring/notificationEvents"}],"content":{"contentType":"group","meta":{"name":"Event Rules and Notifications"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Event Rules and Notifications","showPageActions":true},{"nodeType":"markdoc","content":"Endpoints to view event rules for monitoring and retrieve notifications triggered by changes in monitored companies."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/monitoring/companies/{id}/events","summary":"List Company Events","prefix":{"name":"get","color":"get"},"badges":[],"link":"/event-rules-and-notifications/listcompanyevents","deprecated":false},{"title":"/monitoring/eventRules","summary":"All EventRules","prefix":{"name":"get","color":"get"},"badges":[],"link":"/event-rules-and-notifications/alleventrules","deprecated":false},{"title":"/monitoring/eventRules/{countryCode}","summary":"Filtered EventRules","prefix":{"name":"get","color":"get"},"badges":[],"link":"/event-rules-and-notifications/filteredeventrules","deprecated":false},{"title":"/monitoring/notificationEvents","summary":"All Notification Events","prefix":{"name":"get","color":"get"},"badges":[],"link":"/event-rules-and-notifications/allnotificationevents","deprecated":false}]}]}]}]}},{"type":"separator","label":"KYC Compliance (Know Your Customer)","content":null},{"type":"group","label":"Administrator Resources","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/administrator-resources","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/administrator-resources","items":[{"label":"Return Accepted Country Codes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/administrator-resources/protectgetlookupcountrycodes","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/administrator-resources/protectgetlookupcountrycodes","metadata":{"seo":{"title":"Return Accepted Country Codes","description":"Returns the list of accepted country-codes."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"protectGETLookupCountryCodes","name":"Return Accepted Country Codes","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1lookup~1countryCodes/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return Accepted Country Codes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the list of accepted country-codes."},{"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":"/compliance/kyc-protect/lookup/countryCodes","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","404"],"pointer":"/compliance/kyc-protect/lookup/countryCodes","href":"administrator-resources/protectgetlookupcountrycodes","openApiOperationId":"protectGETLookupCountryCodes","summary":"Return Accepted Country Codes"},"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_446"}},"schemaId":"schema_446"},{"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","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1compliance~1kyc-protect~1lookup~1countryCodes/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_446","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_446"}}},{"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":"/administrator-resources/protectgetlookupcountrycodes"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/lookup/countryCodes"},{"label":"Return Accepted Currency Codes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/administrator-resources/protectgetlookupcurrencycodes","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/administrator-resources/protectgetlookupcurrencycodes","metadata":{"seo":{"title":"Return Accepted Currency Codes","description":"Returns the list of accepted currency codes."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"protectGETLookupCurrencyCodes","name":"Return Accepted Currency Codes","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1lookup~1currencyCodes/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return Accepted Currency Codes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the list of accepted currency codes."},{"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":"/compliance/kyc-protect/lookup/currencyCodes","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","404"],"pointer":"/compliance/kyc-protect/lookup/currencyCodes","href":"administrator-resources/protectgetlookupcurrencycodes","openApiOperationId":"protectGETLookupCurrencyCodes","summary":"Return Accepted Currency Codes"},"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_447"}},"schemaId":"schema_447"},{"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","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1compliance~1kyc-protect~1lookup~1currencyCodes/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_447","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_447"}}},{"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":"/administrator-resources/protectgetlookupcurrencycodes"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/lookup/currencyCodes"},{"label":"Return Sanction Body Details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/administrator-resources/complianceprotectgetlookupsanctionbodies","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/administrator-resources/complianceprotectgetlookupsanctionbodies","metadata":{"seo":{"title":"Return Sanction Body Details","description":"Gets the list of all available sanction body names along with related ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"complianceProtectGETLookupSanctionBodies","name":"Return Sanction Body Details","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1lookup~1sanctionBodies/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return Sanction Body Details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets the list of all available sanction body names along with related 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":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"searchTerm","in":"query","schemaId":"schema_387","description":"The search term to filter sanction bodies."}],"pointer":"/paths/~1compliance~1kyc-protect~1lookup~1sanctionBodies/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/compliance/kyc-protect/lookup/sanctionBodies","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[],"query":[{"name":"searchTerm","in":"query","schemaId":"schema_387"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403"],"pointer":"/compliance/kyc-protect/lookup/sanctionBodies","href":"administrator-resources/complianceprotectgetlookupsanctionbodies","openApiOperationId":"complianceProtectGETLookupSanctionBodies","summary":"Return Sanction Body Details"},"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/KycProtectGetSanctionBodyDetailsResponse"}},"schemaId":"components/schemas/KycProtectGetSanctionBodyDetailsResponse"},{"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/~1compliance~1kyc-protect~1lookup~1sanctionBodies/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/KycProtectGetSanctionBodyDetailsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KycProtectGetSanctionBodyDetailsResponse"}}},{"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":"/administrator-resources/complianceprotectgetlookupsanctionbodies"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/lookup/sanctionBodies"},{"label":"Return Profile Document Types","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/administrator-resources/kycprotectgetprofiledocumenttypes","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/administrator-resources/kycprotectgetprofiledocumenttypes","metadata":{"seo":{"title":"Return Profile Document Types","description":"Returns a list of document types valid for the provided profile type."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"kycProtectGetProfileDocumentTypes","name":"Return Profile Document Types","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1document-types/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return Profile Document Types","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a list of document types valid for the provided profile type."},{"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":"type","in":"query","schemaId":"schema_448","description":"The type of the profile the user wants to return.","required":true}],"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1document-types/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/compliance/kyc-protect/profiles/document-types","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[],"query":[{"name":"type","in":"query","required":true,"schemaId":"schema_448"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403"],"pointer":"/compliance/kyc-protect/profiles/document-types","href":"administrator-resources/kycprotectgetprofiledocumenttypes","openApiOperationId":"kycProtectGetProfileDocumentTypes","summary":"Return Profile Document Types"},"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":"schema_449"}},"schemaId":"schema_449"},{"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/~1compliance~1kyc-protect~1profiles~1document-types/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_449","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_449"}}},{"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":"/administrator-resources/kycprotectgetprofiledocumenttypes"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/profiles/document-types"},{"label":"Return Profile Types","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/administrator-resources/protectgetkycprofiletypes","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/administrator-resources/protectgetkycprofiletypes","metadata":{"seo":{"title":"Return Profile Types","description":"Returns all the profile Types"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"protectGetKycProfileTypes","name":"Return Profile Types","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1types/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return Profile Types","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns all the profile Types"},{"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":"/compliance/kyc-protect/profiles/types","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","404"],"pointer":"/compliance/kyc-protect/profiles/types","href":"administrator-resources/protectgetkycprofiletypes","openApiOperationId":"protectGetKycProfileTypes","summary":"Return Profile Types"},"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/GetKYCProfileTypes"}},"schemaId":"components/schemas/GetKYCProfileTypes"},{"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","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1types/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetKYCProfileTypes","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetKYCProfileTypes"}}},{"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":"/administrator-resources/protectgetkycprofiletypes"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/profiles/types"},{"label":"Return AML Preference Settings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/administrator-resources/compliancegetkycsettingspreferencesaml","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/administrator-resources/compliancegetkycsettingspreferencesaml","metadata":{"seo":{"title":"Return AML Preference Settings","description":"Returns AML preferences for the current logged-in customer,Fetches the AML preferences configured for the current customer, filtered by search type and action type."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"complianceGetKycSettingsPreferencesAml","name":"Return AML Preference Settings","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1settings~1preferences~1aml/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return AML Preference Settings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns AML preferences for the current logged-in customer,Fetches the AML preferences configured for the current customer, filtered by search type and action type."},{"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":"searchType","in":"query","schemaId":"schema_450","description":"The search type: 'individual' or 'business'","required":true},{"name":"searchActionType","in":"query","schemaId":"schema_387","description":"The search action type: 'screening' or 'monitoring'","required":true}],"pointer":"/paths/~1compliance~1kyc-protect~1settings~1preferences~1aml/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/compliance/kyc-protect/settings/preferences/aml","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[],"query":[{"name":"searchType","in":"query","required":true,"schemaId":"schema_450"},{"name":"searchActionType","in":"query","required":true,"schemaId":"schema_387"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/compliance/kyc-protect/settings/preferences/aml","href":"administrator-resources/compliancegetkycsettingspreferencesaml","openApiOperationId":"complianceGetKycSettingsPreferencesAml","summary":"Return AML Preference Settings"},"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/KYCGetSettingsPreferencesAmlResponse"}},"schemaId":"components/schemas/KYCGetSettingsPreferencesAmlResponse"},{"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","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1compliance~1kyc-protect~1settings~1preferences~1aml/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/KYCGetSettingsPreferencesAmlResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KYCGetSettingsPreferencesAmlResponse"}}},{"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":"/administrator-resources/compliancegetkycsettingspreferencesaml"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/settings/preferences/aml"},{"label":"Update AML Preference Settings","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/administrator-resources/complianceputkycsettingspreferencesaml","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/administrator-resources/complianceputkycsettingspreferencesaml","metadata":{"seo":{"title":"Update AML Preference Settings","description":"Updates AML preferences for the current logged-in customer, Allows the customer to update AML preferences such as threshold, search type, action type, datasets, sanction bodies, and PEP tiers. Returns the updated preferences details."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"compliancePutKycSettingsPreferencesAml","name":"Update AML Preference Settings","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1settings~1preferences~1aml/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update AML Preference Settings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates AML preferences for the current logged-in customer, Allows the customer to update AML preferences such as threshold, search type, action type, datasets, sanction bodies, and PEP tiers. Returns the updated preferences 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","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PutKYCSettingsPreferencesAmlRequestBody"}},"schemaId":"components/schemas/PutKYCSettingsPreferencesAmlRequestBody","pointer":"/paths/~1compliance~1kyc-protect~1settings~1preferences~1aml/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/compliance/kyc-protect/settings/preferences/aml","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/PutKYCSettingsPreferencesAmlRequestBody"}},"responseCodes":["200","400","401","403","404"],"pointer":"/compliance/kyc-protect/settings/preferences/aml","href":"administrator-resources/complianceputkycsettingspreferencesaml","openApiOperationId":"compliancePutKycSettingsPreferencesAml","summary":"Update AML Preference Settings"},"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/PutKYCSettingsPreferencesAmlRequestBody","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PutKYCSettingsPreferencesAmlRequestBody"}},"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/KYCGetSettingsPreferencesAmlResponse"}},"schemaId":"components/schemas/KYCGetSettingsPreferencesAmlResponse"},{"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","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1compliance~1kyc-protect~1settings~1preferences~1aml/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/KYCGetSettingsPreferencesAmlResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KYCGetSettingsPreferencesAmlResponse"}}},{"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":"/administrator-resources/complianceputkycsettingspreferencesaml"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/settings/preferences/aml"}],"content":{"contentType":"group","meta":{"name":"Administrator Resources"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Administrator Resources","showPageActions":true},{"nodeType":"markdoc","content":"Endpoints for user management."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/compliance/kyc-protect/lookup/countryCodes","summary":"Return Accepted Country Codes","prefix":{"name":"get","color":"get"},"badges":[],"link":"/administrator-resources/protectgetlookupcountrycodes","deprecated":false},{"title":"/compliance/kyc-protect/lookup/currencyCodes","summary":"Return Accepted Currency Codes","prefix":{"name":"get","color":"get"},"badges":[],"link":"/administrator-resources/protectgetlookupcurrencycodes","deprecated":false},{"title":"/compliance/kyc-protect/lookup/sanctionBodies","summary":"Return Sanction Body Details","prefix":{"name":"get","color":"get"},"badges":[],"link":"/administrator-resources/complianceprotectgetlookupsanctionbodies","deprecated":false},{"title":"/compliance/kyc-protect/profiles/document-types","summary":"Return Profile Document Types","prefix":{"name":"get","color":"get"},"badges":[],"link":"/administrator-resources/kycprotectgetprofiledocumenttypes","deprecated":false},{"title":"/compliance/kyc-protect/profiles/types","summary":"Return Profile Types","prefix":{"name":"get","color":"get"},"badges":[],"link":"/administrator-resources/protectgetkycprofiletypes","deprecated":false},{"title":"/compliance/kyc-protect/settings/preferences/aml","summary":"Return AML Preference Settings","prefix":{"name":"get","color":"get"},"badges":[],"link":"/administrator-resources/compliancegetkycsettingspreferencesaml","deprecated":false},{"title":"/compliance/kyc-protect/settings/preferences/aml","summary":"Update AML Preference Settings","prefix":{"name":"put","color":"put"},"badges":[],"link":"/administrator-resources/complianceputkycsettingspreferencesaml","deprecated":false}]}]}]}]}},{"type":"group","label":"AML Bulk Screening","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-bulk-screening","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-bulk-screening","items":[{"label":"Execute Bulk AML Screening","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-bulk-screening/compliancepostkycsearchesbulkbyprofileid","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-bulk-screening/compliancepostkycsearchesbulkbyprofileid","metadata":{"seo":{"title":"Execute Bulk AML Screening","description":"Request multiple searches to be performed and linked to a profile asynchronously"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"compliancePostKycSearchesBulkByProfileId","name":"Execute Bulk AML Screening","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1searches~1bulk/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Bulk AML Screening","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Request multiple searches to be performed and linked to a profile asynchronously"},{"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":"profileId","in":"path","schemaId":"schema_451","description":"id of the profile","required":true}],"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1searches~1bulk/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_452"}},"schemaId":"schema_452","pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1searches~1bulk/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/compliance/kyc-protect/profiles/{profileId}/searches/bulk","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"schemaId":"schema_451"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_452"}},"responseCodes":["202","400","401","403","404","409"],"pointer":"/compliance/kyc-protect/profiles/{profileId}/searches/bulk","href":"aml-bulk-screening/compliancepostkycsearchesbulkbyprofileid","openApiOperationId":"compliancePostKycSearchesBulkByProfileId","summary":"Execute Bulk AML Screening"},"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_452","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_452"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Accepted"},{"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":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}],"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1searches~1bulk/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202"},{"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":"409","schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/aml-bulk-screening/compliancepostkycsearchesbulkbyprofileid"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/profiles/{profileId}/searches/bulk"}],"content":{"contentType":"group","meta":{"name":"AML Bulk Screening"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"AML Bulk Screening","showPageActions":true},{"nodeType":"markdoc","content":"Endpoints to perform bulk AML screenings for multiple businesses or individuals in a single request."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/compliance/kyc-protect/profiles/{profileId}/searches/bulk","summary":"Execute Bulk AML Screening","prefix":{"name":"post","color":"post"},"badges":[],"link":"/aml-bulk-screening/compliancepostkycsearchesbulkbyprofileid","deprecated":false}]}]}]}]}},{"type":"group","label":"AML Monitoring Management","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-monitoring-management","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-monitoring-management","items":[{"label":"Add Search To AML Monitoring","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-monitoring-management/kycprotectcreateschedule","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-monitoring-management/kycprotectcreateschedule","metadata":{"seo":{"title":"Add Search To AML Monitoring","description":"Adds the specified searches to AML monitoring, i.e. schedules them for screening. If thresholds and datasets are amended from the original search, new results will generated. Any existing hits will be overridden and any previous match decisions will be reset.  Important A pre-requisite for monitoring work is that any searches MUST be linked to a profile before Monitoring can be Active."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"kycProtectCreateSchedule","name":"Add Search To AML Monitoring","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1schedules/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add Search To AML Monitoring","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":"Adds the specified searches to AML monitoring, i.e. schedules them for screening. If thresholds and datasets are amended from the original search, new results will generated. Any existing hits will be overridden and any previous match decisions will be reset. "},"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":"Important"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" A pre-requisite for monitoring work is that any searches MUST be linked to a profile before Monitoring can be Active."},"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":"schema_453"}},"schemaId":"schema_453","pointer":"/paths/~1compliance~1kyc-protect~1schedules/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/compliance/kyc-protect/schedules","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_453"}},"responseCodes":["200","400","401","403"],"pointer":"/compliance/kyc-protect/schedules","href":"aml-monitoring-management/kycprotectcreateschedule","openApiOperationId":"kycProtectCreateSchedule","summary":"Add Search To AML Monitoring"},"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_453","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_453"}},"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/PostKYCProtectSchedulesResponse"}},"schemaId":"components/schemas/PostKYCProtectSchedulesResponse"},{"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/~1compliance~1kyc-protect~1schedules/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PostKYCProtectSchedulesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PostKYCProtectSchedulesResponse"}}},{"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":"/aml-monitoring-management/kycprotectcreateschedule"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/schedules"},{"label":"Return All Ordered Schedules","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-monitoring-management/kycprotectgetschedules","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-monitoring-management/kycprotectgetschedules","metadata":{"seo":{"title":"Return All Ordered Schedules","description":"Returns all schedules ordered by modified date."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"kycProtectGetSchedules","name":"Return All Ordered Schedules","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1schedules/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return All Ordered Schedules","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns all schedules ordered by modified date."},{"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_398","description":"Starting page number."},{"name":"pageSize","in":"query","schemaId":"schema_388","description":"Specifies the number of items to be displayed per page. Allowed values are between 1 and 100."}],"pointer":"/paths/~1compliance~1kyc-protect~1schedules/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/compliance/kyc-protect/schedules","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_398"},{"name":"pageSize","in":"query","schemaId":"schema_388"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/compliance/kyc-protect/schedules","href":"aml-monitoring-management/kycprotectgetschedules","openApiOperationId":"kycProtectGetSchedules","summary":"Return All Ordered Schedules"},"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/ScheduleResponse"}},"schemaId":"components/schemas/ScheduleResponse"},{"code":"400","description":"Forbidden","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","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1compliance~1kyc-protect~1schedules/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ScheduleResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ScheduleResponse"}}},{"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":"/aml-monitoring-management/kycprotectgetschedules"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/schedules"},{"label":"Delete Searches From AML Monitoring","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-monitoring-management/kycprotectdeleteschedules","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-monitoring-management/kycprotectdeleteschedules","metadata":{"seo":{"title":"Delete Searches From AML Monitoring","description":"Removes the specified searches from AML monitoring."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"kycProtectDeleteSchedules","name":"Delete Searches From AML Monitoring","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1schedules/delete","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Searches From AML Monitoring","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Removes the specified searches from AML monitoring."},{"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_454"}},"schemaId":"schema_454","pointer":"/paths/~1compliance~1kyc-protect~1schedules/delete/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/compliance/kyc-protect/schedules","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_454"}},"responseCodes":["200","400","401","403"],"pointer":"/compliance/kyc-protect/schedules","href":"aml-monitoring-management/kycprotectdeleteschedules","openApiOperationId":"kycProtectDeleteSchedules","summary":"Delete Searches From AML Monitoring"},"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_454","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_454"}},"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/DeleteKYCProtectSchedulesResponse"}},"schemaId":"components/schemas/DeleteKYCProtectSchedulesResponse"},{"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/~1compliance~1kyc-protect~1schedules/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/DeleteKYCProtectSchedulesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DeleteKYCProtectSchedulesResponse"}}},{"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":"/aml-monitoring-management/kycprotectdeleteschedules"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/schedules"},{"label":"Update Schedules","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-monitoring-management/kycprotectputschedules","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-monitoring-management/kycprotectputschedules","metadata":{"seo":{"title":"Update Schedules","description":"Updates schedules in AML monitoring."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"kycProtectPutSchedules","name":"Update Schedules","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1schedules/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Schedules","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates schedules in AML monitoring."},{"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/MODEL1e2683"}},"schemaId":"components/schemas/MODEL1e2683","pointer":"/paths/~1compliance~1kyc-protect~1schedules/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/compliance/kyc-protect/schedules","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/MODEL1e2683"}},"responseCodes":["200","400","401","403"],"pointer":"/compliance/kyc-protect/schedules","href":"aml-monitoring-management/kycprotectputschedules","openApiOperationId":"kycProtectPutSchedules","summary":"Update Schedules"},"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/MODEL1e2683","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/MODEL1e2683"}},"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/PutKYCProtectSchedulesResponse"}},"schemaId":"components/schemas/PutKYCProtectSchedulesResponse"},{"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/~1compliance~1kyc-protect~1schedules/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PutKYCProtectSchedulesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PutKYCProtectSchedulesResponse"}}},{"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":"/aml-monitoring-management/kycprotectputschedules"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/schedules"},{"label":"Return A Schedule","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-monitoring-management/kycprotectgetschedulesbyscheduleid","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-monitoring-management/kycprotectgetschedulesbyscheduleid","metadata":{"seo":{"title":"Return A Schedule","description":"Returns a schedule in AML monitoring."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"kycProtectGetSchedulesByScheduleId","name":"Return A Schedule","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1schedules~1{scheduleId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return A Schedule","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a schedule in AML monitoring."},{"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":"scheduleId","in":"path","schemaId":"schema_451","description":"id of the profile","required":true}],"pointer":"/paths/~1compliance~1kyc-protect~1schedules~1{scheduleId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/compliance/kyc-protect/schedules/{scheduleId}","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"scheduleId","in":"path","required":true,"schemaId":"schema_451"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/compliance/kyc-protect/schedules/{scheduleId}","href":"aml-monitoring-management/kycprotectgetschedulesbyscheduleid","openApiOperationId":"kycProtectGetSchedulesByScheduleId","summary":"Return A Schedule"},"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":"schema_455"}},"schemaId":"schema_455"},{"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","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1compliance~1kyc-protect~1schedules~1{scheduleId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_455","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_455"}}},{"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":"/aml-monitoring-management/kycprotectgetschedulesbyscheduleid"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/schedules/{scheduleId}"},{"label":"Delete A Search From AML Monitoring","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-monitoring-management/kycprotectdeleteschedulesbyscheduleid","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-monitoring-management/kycprotectdeleteschedulesbyscheduleid","metadata":{"seo":{"title":"Delete A Search From AML Monitoring","description":"Removes a search from AML monitoring."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"kycProtectDeleteSchedulesByScheduleId","name":"Delete A Search From AML Monitoring","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1schedules~1{scheduleId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete A Search From AML Monitoring","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Removes a search from AML monitoring."},{"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":"scheduleId","in":"path","schemaId":"schema_451","description":"id of the profile","required":true}],"pointer":"/paths/~1compliance~1kyc-protect~1schedules~1{scheduleId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/compliance/kyc-protect/schedules/{scheduleId}","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"scheduleId","in":"path","required":true,"schemaId":"schema_451"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","400","401","403","404"],"pointer":"/compliance/kyc-protect/schedules/{scheduleId}","href":"aml-monitoring-management/kycprotectdeleteschedulesbyscheduleid","openApiOperationId":"kycProtectDeleteSchedulesByScheduleId","summary":"Delete A Search From AML Monitoring"},"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":"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","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1compliance~1kyc-protect~1schedules~1{scheduleId}/delete/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":"/aml-monitoring-management/kycprotectdeleteschedulesbyscheduleid"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/schedules/{scheduleId}"},{"label":"Update A Schedule In Monitoring","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-monitoring-management/kycprotectputschedulesbyscheduleid","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-monitoring-management/kycprotectputschedulesbyscheduleid","metadata":{"seo":{"title":"Update A Schedule In Monitoring","description":"Updates a schedule in AML monitoring.  When there is a change in threshold or datasets, the system will deduct one credit for screening."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"kycProtectPutSchedulesByScheduleId","name":"Update A Schedule In Monitoring","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1schedules~1{scheduleId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update A Schedule In Monitoring","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":"Updates a schedule in AML monitoring. "},"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":" When there is a change in threshold or datasets, the system will deduct one credit for screening."},"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":"scheduleId","in":"path","schemaId":"schema_451","description":"id of the profile","required":true}],"pointer":"/paths/~1compliance~1kyc-protect~1schedules~1{scheduleId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/MODEL6bcc20"}},"schemaId":"components/schemas/MODEL6bcc20","pointer":"/paths/~1compliance~1kyc-protect~1schedules~1{scheduleId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/compliance/kyc-protect/schedules/{scheduleId}","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"scheduleId","in":"path","required":true,"schemaId":"schema_451"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/MODEL6bcc20"}},"responseCodes":["200","400","401","403"],"pointer":"/compliance/kyc-protect/schedules/{scheduleId}","href":"aml-monitoring-management/kycprotectputschedulesbyscheduleid","openApiOperationId":"kycProtectPutSchedulesByScheduleId","summary":"Update A Schedule In Monitoring"},"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/MODEL6bcc20","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/MODEL6bcc20"}},"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_456"}},"schemaId":"schema_456"},{"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/~1compliance~1kyc-protect~1schedules~1{scheduleId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_456","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_456"}}},{"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":"/aml-monitoring-management/kycprotectputschedulesbyscheduleid"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/schedules/{scheduleId}"},{"label":"Return All Hits For A Schedule By Created Date","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-monitoring-management/kycprotectgetschedulesamlalerts","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-monitoring-management/kycprotectgetschedulesamlalerts","metadata":{"seo":{"title":"Return All Hits For A Schedule By Created Date","description":"Get all hits for an AML monitoring schedule ordered by hit created date."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"kycProtectGetSchedulesAmlAlerts","name":"Return All Hits For A Schedule By Created Date","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1schedules~1amlAlerts/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return All Hits For A Schedule By Created Date","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get all hits for an AML monitoring schedule ordered by hit created date."},{"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_398","description":"Starting page number."},{"name":"pageSize","in":"query","schemaId":"schema_388","description":"Specifies the number of items to be displayed per page. Allowed values are between 1 and 100."},{"name":"hitDecisions","in":"query","schemaId":"schema_449","description":"The hit decisions to filter by. It can be the collection of undecided, truematch, falsepositive, discarded"},{"name":"fromDate","in":"query","schemaId":"schema_457","description":"Start date to filter."},{"name":"toDate","in":"query","schemaId":"schema_457","description":"End date to filter."}],"pointer":"/paths/~1compliance~1kyc-protect~1schedules~1amlAlerts/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/compliance/kyc-protect/schedules/amlAlerts","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_398"},{"name":"pageSize","in":"query","schemaId":"schema_388"},{"name":"hitDecisions","in":"query","schemaId":"schema_449"},{"name":"fromDate","in":"query","example":"2015-07-04","schemaId":"schema_457"},{"name":"toDate","in":"query","example":"2015-07-04","schemaId":"schema_457"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","409"],"pointer":"/compliance/kyc-protect/schedules/amlAlerts","href":"aml-monitoring-management/kycprotectgetschedulesamlalerts","openApiOperationId":"kycProtectGetSchedulesAmlAlerts","summary":"Return All Hits For A Schedule By Created Date"},"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":"schema_458"}},"schemaId":"schema_458"},{"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":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}],"pointer":"/paths/~1compliance~1kyc-protect~1schedules~1amlAlerts/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_458","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_458"}}},{"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":"409","schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/aml-monitoring-management/kycprotectgetschedulesamlalerts"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/schedules/amlAlerts"}],"content":{"contentType":"group","meta":{"name":"AML Monitoring Management"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"AML Monitoring Management","showPageActions":true},{"nodeType":"markdoc","content":"Endpoints to set up and manage ongoing AML monitoring for profiles, including receiving alerts for changes or risks."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/compliance/kyc-protect/schedules","summary":"Add Search To AML Monitoring","prefix":{"name":"post","color":"post"},"badges":[],"link":"/aml-monitoring-management/kycprotectcreateschedule","deprecated":false},{"title":"/compliance/kyc-protect/schedules","summary":"Return All Ordered Schedules","prefix":{"name":"get","color":"get"},"badges":[],"link":"/aml-monitoring-management/kycprotectgetschedules","deprecated":false},{"title":"/compliance/kyc-protect/schedules","summary":"Delete Searches From AML Monitoring","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/aml-monitoring-management/kycprotectdeleteschedules","deprecated":false},{"title":"/compliance/kyc-protect/schedules","summary":"Update Schedules","prefix":{"name":"put","color":"put"},"badges":[],"link":"/aml-monitoring-management/kycprotectputschedules","deprecated":false},{"title":"/compliance/kyc-protect/schedules/{scheduleId}","summary":"Return A Schedule","prefix":{"name":"get","color":"get"},"badges":[],"link":"/aml-monitoring-management/kycprotectgetschedulesbyscheduleid","deprecated":false},{"title":"/compliance/kyc-protect/schedules/{scheduleId}","summary":"Delete A Search From AML Monitoring","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/aml-monitoring-management/kycprotectdeleteschedulesbyscheduleid","deprecated":false},{"title":"/compliance/kyc-protect/schedules/{scheduleId}","summary":"Update A Schedule In Monitoring","prefix":{"name":"put","color":"put"},"badges":[],"link":"/aml-monitoring-management/kycprotectputschedulesbyscheduleid","deprecated":false},{"title":"/compliance/kyc-protect/schedules/amlAlerts","summary":"Return All Hits For A Schedule By Created Date","prefix":{"name":"get","color":"get"},"badges":[],"link":"/aml-monitoring-management/kycprotectgetschedulesamlalerts","deprecated":false}]}]}]}]}},{"type":"group","label":"AML Screening - Businesses","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-businesses","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-businesses","items":[{"label":"Execute An AML Search For A Business And Saves The Results To The Database","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-businesses/kycsearchbusiness","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-businesses/kycsearchbusiness","metadata":{"seo":{"title":"Execute An AML Search For A Business And Saves The Results To The Database","description":"A request requires a name, at least one valid dataset, and a threshold. User will be deducted 1 credit for each AML search."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"kycSearchBusiness","name":"Execute An AML Search For A Business And Saves The Results To The Database","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1searches~1businesses/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute An AML Search For A Business And Saves The Results To The Database","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"A request requires a name, at least one valid dataset, and a threshold. User will be deducted 1 credit for each AML search."},{"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":"schema_459"}},"schemaId":"schema_459","pointer":"/paths/~1compliance~1kyc-protect~1searches~1businesses/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/compliance/kyc-protect/searches/businesses","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_459"}},"responseCodes":["201","400","401","403"],"pointer":"/compliance/kyc-protect/searches/businesses","href":"aml-screening-businesses/kycsearchbusiness","openApiOperationId":"kycSearchBusiness","summary":"Execute An AML Search For A Business And Saves The Results To The Database"},"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_459","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_459"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MODEL931a1b"}},"schemaId":"components/schemas/MODEL931a1b"},{"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/~1compliance~1kyc-protect~1searches~1businesses/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/MODEL931a1b","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MODEL931a1b"}}},{"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":"/aml-screening-businesses/kycsearchbusiness"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/searches/businesses"},{"label":"Return Business AML Searches","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-businesses/kycsearchbusinessget","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-businesses/kycsearchbusinessget","metadata":{"seo":{"title":"Return Business AML Searches","description":"Returns a list of business AML searches ordered by modified date."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"kycSearchBusinessGet","name":"Return Business AML Searches","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1searches~1businesses/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return Business AML Searches","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a list of business AML searches ordered by modified date."},{"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_398","description":"Starting page number."},{"name":"pageSize","in":"query","schemaId":"schema_388","description":"Specifies the number of items to be displayed per page. Allowed values are between 1 and 100."},{"name":"isScheduled","in":"query","schemaId":"schema_428"}],"pointer":"/paths/~1compliance~1kyc-protect~1searches~1businesses/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/compliance/kyc-protect/searches/businesses","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_398"},{"name":"pageSize","in":"query","schemaId":"schema_388"},{"name":"isScheduled","in":"query","schemaId":"schema_428"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403"],"pointer":"/compliance/kyc-protect/searches/businesses","href":"aml-screening-businesses/kycsearchbusinessget","openApiOperationId":"kycSearchBusinessGet","summary":"Return Business AML Searches"},"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/MODELf73bb1"}},"schemaId":"components/schemas/MODELf73bb1"},{"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/~1compliance~1kyc-protect~1searches~1businesses/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/MODELf73bb1","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MODELf73bb1"}}},{"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":"/aml-screening-businesses/kycsearchbusinessget"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/searches/businesses"},{"label":"Update Business AML Searches","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-businesses/kycsearchbusinessput","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-businesses/kycsearchbusinessput","metadata":{"seo":{"title":"Update Business AML Searches","description":"Updates a batch of business AML searches."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"kycSearchBusinessPut","name":"Update Business AML Searches","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1searches~1businesses/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Business AML Searches","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates a batch of business AML searches."},{"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_460"}},"schemaId":"schema_460","pointer":"/paths/~1compliance~1kyc-protect~1searches~1businesses/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/compliance/kyc-protect/searches/businesses","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_460"}},"responseCodes":["200","400","401","403"],"pointer":"/compliance/kyc-protect/searches/businesses","href":"aml-screening-businesses/kycsearchbusinessput","openApiOperationId":"kycSearchBusinessPut","summary":"Update Business AML Searches"},"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_460","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_460"}},"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/KYCPUTSearchBusinessesResponse"}},"schemaId":"components/schemas/KYCPUTSearchBusinessesResponse"},{"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/~1compliance~1kyc-protect~1searches~1businesses/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/KYCPUTSearchBusinessesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KYCPUTSearchBusinessesResponse"}}},{"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":"/aml-screening-businesses/kycsearchbusinessput"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/searches/businesses"},{"label":"Return Business AML Search By Search Id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-businesses/getkycsearchbusinessbysearchid","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-businesses/getkycsearchbusinessbysearchid","metadata":{"seo":{"title":"Return Business AML Search By Search Id","description":"Returns a single AML search based on Search id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getKycSearchBusinessBySearchId","name":"Return Business AML Search By Search Id","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1searches~1businesses~1{searchId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return Business AML Search By Search Id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a single AML search based on Search 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":"searchId","in":"path","schemaId":"schema_387","description":"Id of the search","required":true}],"pointer":"/paths/~1compliance~1kyc-protect~1searches~1businesses~1{searchId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/compliance/kyc-protect/searches/businesses/{searchId}","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"searchId","in":"path","required":true,"schemaId":"schema_387"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403"],"pointer":"/compliance/kyc-protect/searches/businesses/{searchId}","href":"aml-screening-businesses/getkycsearchbusinessbysearchid","openApiOperationId":"getKycSearchBusinessBySearchId","summary":"Return Business AML Search By Search 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","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KYCGetSearchBusinessesBySearchIdResponse"}},"schemaId":"components/schemas/KYCGetSearchBusinessesBySearchIdResponse"},{"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/~1compliance~1kyc-protect~1searches~1businesses~1{searchId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/KYCGetSearchBusinessesBySearchIdResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KYCGetSearchBusinessesBySearchIdResponse"}}},{"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":"/aml-screening-businesses/getkycsearchbusinessbysearchid"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/searches/businesses/{searchId}"},{"label":"Update A Business AML Search By Search Id","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-businesses/putkycsearchbusinessbysearchid","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-businesses/putkycsearchbusinessbysearchid","metadata":{"seo":{"title":"Update A Business AML Search By Search Id","description":"Updates a business AML search."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"putKycSearchBusinessBySearchId","name":"Update A Business AML Search By Search Id","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1searches~1businesses~1{searchId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update A Business AML Search By Search Id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates a business AML search."},{"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":"searchId","in":"path","schemaId":"schema_387","description":"Id of the search","required":true}],"pointer":"/paths/~1compliance~1kyc-protect~1searches~1businesses~1{searchId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_461"}},"schemaId":"schema_461","pointer":"/paths/~1compliance~1kyc-protect~1searches~1businesses~1{searchId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/compliance/kyc-protect/searches/businesses/{searchId}","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"searchId","in":"path","required":true,"schemaId":"schema_387"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_461"}},"responseCodes":["200","400","401","403"],"pointer":"/compliance/kyc-protect/searches/businesses/{searchId}","href":"aml-screening-businesses/putkycsearchbusinessbysearchid","openApiOperationId":"putKycSearchBusinessBySearchId","summary":"Update A Business AML Search By Search 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"}],"schemaId":"schema_461","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_461"}},"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/KYCPutSearchBusinessesBySearchIdResponse"}},"schemaId":"components/schemas/KYCPutSearchBusinessesBySearchIdResponse"},{"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/~1compliance~1kyc-protect~1searches~1businesses~1{searchId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/KYCPutSearchBusinessesBySearchIdResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KYCPutSearchBusinessesBySearchIdResponse"}}},{"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":"/aml-screening-businesses/putkycsearchbusinessbysearchid"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/searches/businesses/{searchId}"},{"label":"Download PDF Business Search Report","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-businesses/compliancegetkycsearchbusinessdownloadbysearchid","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-businesses/compliancegetkycsearchbusinessdownloadbysearchid","metadata":{"seo":{"title":"Download PDF Business Search Report","description":"Returns a business search report for the user's customer based on search id retrieves data using the POST method to allow inclusion of request payload."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"complianceGetKycSearchBusinessDownloadBySearchId","name":"Download PDF Business Search Report","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1searches~1businesses~1{searchId}~1download/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download PDF Business Search Report","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a business search report for the user's customer based on search id retrieves data using the POST method to allow inclusion of request payload."},{"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":"searchId","in":"path","schemaId":"schema_387","description":"Id of the search","required":true}],"pointer":"/paths/~1compliance~1kyc-protect~1searches~1businesses~1{searchId}~1download/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_462"}},"schemaId":"schema_462","pointer":"/paths/~1compliance~1kyc-protect~1searches~1businesses~1{searchId}~1download/post/requestBody","description":"Supply a list of hit Id's from the searchId supplied for the PDF to be created."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/compliance/kyc-protect/searches/businesses/{searchId}/download","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"searchId","in":"path","required":true,"schemaId":"schema_387"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_462"}},"responseCodes":["200","400","401","403","404"],"pointer":"/compliance/kyc-protect/searches/businesses/{searchId}/download","href":"aml-screening-businesses/compliancegetkycsearchbusinessdownloadbysearchid","openApiOperationId":"complianceGetKycSearchBusinessDownloadBySearchId","summary":"Download PDF Business Search 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"}],"schemaId":"schema_462","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_462"}},"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/KYCGetSearchBusinessesDownloadBySearchIdResponse"}},"schemaId":"components/schemas/KYCGetSearchBusinessesDownloadBySearchIdResponse"},{"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","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1compliance~1kyc-protect~1searches~1businesses~1{searchId}~1download/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/KYCGetSearchBusinessesDownloadBySearchIdResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KYCGetSearchBusinessesDownloadBySearchIdResponse"}}},{"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":"/aml-screening-businesses/compliancegetkycsearchbusinessdownloadbysearchid"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/searches/businesses/{searchId}/download"},{"label":"Return Business AML Search Hits","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-businesses/getkycsearchbusinesshitsbysearchid","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-businesses/getkycsearchbusinesshitsbysearchid","metadata":{"seo":{"title":"Return Business AML Search Hits","description":"Returns the business AML search hits from the AML search results."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getKycSearchBusinessHitsBySearchId","name":"Return Business AML Search Hits","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1searches~1businesses~1{searchId}~1hits/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return Business AML Search Hits","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the business AML search hits from the AML search results."},{"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":"searchId","in":"path","schemaId":"schema_387","description":"Id of the search","required":true}],"pointer":"/paths/~1compliance~1kyc-protect~1searches~1businesses~1{searchId}~1hits/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_398","description":"Starting page number."},{"name":"pageSize","in":"query","schemaId":"schema_388","description":"Specifies the number of items to be displayed per page. Allowed values are between 1 and 100."},{"name":"hitDecisions","in":"query","schemaId":"schema_449","description":"The hit decisions. It can be the collection of undecided, truematch, falsepositive, discarded"}],"pointer":"/paths/~1compliance~1kyc-protect~1searches~1businesses~1{searchId}~1hits/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/compliance/kyc-protect/searches/businesses/{searchId}/hits","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"searchId","in":"path","required":true,"schemaId":"schema_387"}],"query":[{"name":"page","in":"query","schemaId":"schema_398"},{"name":"pageSize","in":"query","schemaId":"schema_388"},{"name":"hitDecisions","in":"query","schemaId":"schema_449"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/compliance/kyc-protect/searches/businesses/{searchId}/hits","href":"aml-screening-businesses/getkycsearchbusinesshitsbysearchid","openApiOperationId":"getKycSearchBusinessHitsBySearchId","summary":"Return Business AML Search Hits"},"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/KYCGetSearchBusinessesBySearchIdHitsResponse"}},"schemaId":"components/schemas/KYCGetSearchBusinessesBySearchIdHitsResponse"},{"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","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1compliance~1kyc-protect~1searches~1businesses~1{searchId}~1hits/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/KYCGetSearchBusinessesBySearchIdHitsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KYCGetSearchBusinessesBySearchIdHitsResponse"}}},{"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":"/aml-screening-businesses/getkycsearchbusinesshitsbysearchid"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/searches/businesses/{searchId}/hits"},{"label":"Update Batch Of Business AML Search Hits","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-businesses/putkycsearchbusinesshitsbysearchid","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-businesses/putkycsearchbusinesshitsbysearchid","metadata":{"seo":{"title":"Update Batch Of Business AML Search Hits","description":"Updates a batch of business AML search hits."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"putKycSearchBusinessHitsBySearchId","name":"Update Batch Of Business AML Search Hits","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1searches~1businesses~1{searchId}~1hits/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Batch Of Business AML Search Hits","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates a batch of business AML search hits."},{"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":"searchId","in":"path","schemaId":"schema_387","description":"Id of the search","required":true}],"pointer":"/paths/~1compliance~1kyc-protect~1searches~1businesses~1{searchId}~1hits/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/MODEL7b2457"}},"schemaId":"components/schemas/MODEL7b2457","pointer":"/paths/~1compliance~1kyc-protect~1searches~1businesses~1{searchId}~1hits/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/compliance/kyc-protect/searches/businesses/{searchId}/hits","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"searchId","in":"path","required":true,"schemaId":"schema_387"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/MODEL7b2457"}},"responseCodes":["200","400","401","403","404"],"pointer":"/compliance/kyc-protect/searches/businesses/{searchId}/hits","href":"aml-screening-businesses/putkycsearchbusinesshitsbysearchid","openApiOperationId":"putKycSearchBusinessHitsBySearchId","summary":"Update Batch Of Business AML Search Hits"},"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/MODEL7b2457","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/MODEL7b2457"}},"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/KYCPutSearchBusinessesBySearchIdHitsResponse"}},"schemaId":"components/schemas/KYCPutSearchBusinessesBySearchIdHitsResponse"},{"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","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1compliance~1kyc-protect~1searches~1businesses~1{searchId}~1hits/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/KYCPutSearchBusinessesBySearchIdHitsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KYCPutSearchBusinessesBySearchIdHitsResponse"}}},{"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":"/aml-screening-businesses/putkycsearchbusinesshitsbysearchid"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/searches/businesses/{searchId}/hits"},{"label":"Return Full AML Search Hit Information By SearchId And HitId","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-businesses/getkycsearchbusinesshitsbysearchidandhitid","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-businesses/getkycsearchbusinesshitsbysearchidandhitid","metadata":{"seo":{"title":"Return Full AML Search Hit Information By SearchId And HitId","description":"This endpoint will return the full hit information by search Id and hitId.  Once this information is requested the information returned is stored to the database as a snap shot of that point in time."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getKycSearchBusinessHitsBySearchIdAndHitId","name":"Return Full AML Search Hit Information By SearchId And HitId","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1searches~1businesses~1{searchId}~1hits~1{hitId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return Full AML Search Hit Information By SearchId And HitId","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 the full hit information by search Id and hitId. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Once this information is requested the information returned is stored to the database as a snap shot of that point in time."},"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":"searchId","in":"path","schemaId":"schema_387","description":"Id of the search","required":true},{"name":"hitId","in":"path","schemaId":"schema_387","description":"Id of the hit","required":true}],"pointer":"/paths/~1compliance~1kyc-protect~1searches~1businesses~1{searchId}~1hits~1{hitId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/compliance/kyc-protect/searches/businesses/{searchId}/hits/{hitId}","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"searchId","in":"path","required":true,"schemaId":"schema_387"},{"name":"hitId","in":"path","required":true,"schemaId":"schema_387"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/compliance/kyc-protect/searches/businesses/{searchId}/hits/{hitId}","href":"aml-screening-businesses/getkycsearchbusinesshitsbysearchidandhitid","openApiOperationId":"getKycSearchBusinessHitsBySearchIdAndHitId","summary":"Return Full AML Search Hit Information By SearchId And HitId"},"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/WebApiModelsSearchesSearchResultHitsBusinessSearchResultHitResponse"}},"schemaId":"components/schemas/WebApiModelsSearchesSearchResultHitsBusinessSearchResultHitResponse"},{"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","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1compliance~1kyc-protect~1searches~1businesses~1{searchId}~1hits~1{hitId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/WebApiModelsSearchesSearchResultHitsBusinessSearchResultHitResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebApiModelsSearchesSearchResultHitsBusinessSearchResultHitResponse"}}},{"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":"/aml-screening-businesses/getkycsearchbusinesshitsbysearchidandhitid"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/searches/businesses/{searchId}/hits/{hitId}"},{"label":"Update A Single Business Hit","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-businesses/putkycsearchbusinessbysearchidandhitid","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-businesses/putkycsearchbusinessbysearchidandhitid","metadata":{"seo":{"title":"Update A Single Business Hit","description":"This endpoint will update a single business AML search hit by searchId and hitId."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"putKycSearchBusinessBySearchIdAndHitId","name":"Update A Single Business Hit","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1searches~1businesses~1{searchId}~1hits~1{hitId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update A Single Business Hit","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 a single business AML search hit by searchId and hitId."},{"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":"searchId","in":"path","schemaId":"schema_387","description":"Id of the search","required":true},{"name":"hitId","in":"path","schemaId":"schema_387","required":true}],"pointer":"/paths/~1compliance~1kyc-protect~1searches~1businesses~1{searchId}~1hits~1{hitId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_463"}},"schemaId":"schema_463","pointer":"/paths/~1compliance~1kyc-protect~1searches~1businesses~1{searchId}~1hits~1{hitId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/compliance/kyc-protect/searches/businesses/{searchId}/hits/{hitId}","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"searchId","in":"path","required":true,"schemaId":"schema_387"},{"name":"hitId","in":"path","required":true,"schemaId":"schema_387"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_463"}},"responseCodes":["200","400","401","403","404"],"pointer":"/compliance/kyc-protect/searches/businesses/{searchId}/hits/{hitId}","href":"aml-screening-businesses/putkycsearchbusinessbysearchidandhitid","openApiOperationId":"putKycSearchBusinessBySearchIdAndHitId","summary":"Update A Single Business Hit"},"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_463","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_463"}},"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/KYCBusinessSearchResultHitSummaryResponse"}},"schemaId":"components/schemas/KYCBusinessSearchResultHitSummaryResponse"},{"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","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1compliance~1kyc-protect~1searches~1businesses~1{searchId}~1hits~1{hitId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/KYCBusinessSearchResultHitSummaryResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KYCBusinessSearchResultHitSummaryResponse"}}},{"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":"/aml-screening-businesses/putkycsearchbusinessbysearchidandhitid"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/searches/businesses/{searchId}/hits/{hitId}"},{"label":"Download AML Details for a Hit","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-businesses/compliancegetkycsearchbusinesshitsbysearchidandhitiddownload","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-businesses/compliancegetkycsearchbusinesshitsbysearchidandhitiddownload","metadata":{"seo":{"title":"Download AML Details for a Hit","description":"Retrieves the download URL and metadata for the AML details PDF associated with a specific hit  within a business search.  Use this endpoint to obtain the PDF file containing detailed AML information for a flagged  result (hitId) from a previously performed search (searchId). The response includes the  download URL, file name, expiration timestamp, and identifiers for the search and hit."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"complianceGetKycSearchBusinessHitsBySearchIdAndHitIdDownload","name":"Download AML Details for a Hit","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1searches~1businesses~1{searchId}~1hits~1{hitId}~1download/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download AML Details for a Hit","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 the download URL and metadata for the AML details PDF associated with a specific hit  within a business search. "},"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":" Use this endpoint to obtain the PDF file containing detailed AML information for a flagged  result ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hitId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") from a previously performed search ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"searchId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). The response includes the  download URL, file name, expiration timestamp, and identifiers for the search and hit."},"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":"searchId","in":"path","schemaId":"schema_451","description":"The unique identifier of the search that generated the hit. This ID links the request  to the specific search performed in the KYC Protect system.\n","required":true},{"name":"hitId","in":"path","schemaId":"schema_451","description":"The unique identifier of the hit associated with the search. This ID is used to retrieve  the specific details of a flagged result from the search.\n","required":true}],"pointer":"/paths/~1compliance~1kyc-protect~1searches~1businesses~1{searchId}~1hits~1{hitId}~1download/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/compliance/kyc-protect/searches/businesses/{searchId}/hits/{hitId}/download","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"searchId","in":"path","required":true,"schemaId":"schema_451"},{"name":"hitId","in":"path","required":true,"schemaId":"schema_451"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/compliance/kyc-protect/searches/businesses/{searchId}/hits/{hitId}/download","href":"aml-screening-businesses/compliancegetkycsearchbusinesshitsbysearchidandhitiddownload","openApiOperationId":"complianceGetKycSearchBusinessHitsBySearchIdAndHitIdDownload","summary":"Download AML Details for a Hit"},"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/WebApiModelsSearchesSearchResultHitsBusinessSearchHitAttachmentLinkResponse"}},"schemaId":"components/schemas/WebApiModelsSearchesSearchResultHitsBusinessSearchHitAttachmentLinkResponse"},{"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","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1compliance~1kyc-protect~1searches~1businesses~1{searchId}~1hits~1{hitId}~1download/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/WebApiModelsSearchesSearchResultHitsBusinessSearchHitAttachmentLinkResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebApiModelsSearchesSearchResultHitsBusinessSearchHitAttachmentLinkResponse"}}},{"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":"/aml-screening-businesses/compliancegetkycsearchbusinesshitsbysearchidandhitiddownload"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/searches/businesses/{searchId}/hits/{hitId}/download"},{"label":"Update The Note For A Single Businesses Hit","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-businesses/compliancekycprotectsearchesbusinessessearchidhitshitidnoteput","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-businesses/compliancekycprotectsearchesbusinessessearchidhitshitidnoteput","metadata":{"seo":{"title":"Update The Note For A Single Businesses Hit","description":"Update The Note For A Single Businesses Hit"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"complianceKycProtectSearchesBusinessesSearchIdHitsHitIdNotePut","name":"Update The Note For A Single Businesses Hit","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1searches~1businesses~1{searchId}~1hits~1{hitId}~1note/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update The Note For A Single Businesses Hit","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"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":"searchId","in":"path","schemaId":"schema_387","required":true},{"name":"hitId","in":"path","schemaId":"schema_387","required":true}],"pointer":"/paths/~1compliance~1kyc-protect~1searches~1businesses~1{searchId}~1hits~1{hitId}~1note/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_464"}},"schemaId":"schema_464","pointer":"/paths/~1compliance~1kyc-protect~1searches~1businesses~1{searchId}~1hits~1{hitId}~1note/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/compliance/kyc-protect/searches/businesses/{searchId}/hits/{hitId}/note","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"searchId","in":"path","required":true,"schemaId":"schema_387"},{"name":"hitId","in":"path","required":true,"schemaId":"schema_387"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_464"}},"responseCodes":["200","400","401","403","404"],"pointer":"/compliance/kyc-protect/searches/businesses/{searchId}/hits/{hitId}/note","href":"aml-screening-businesses/compliancekycprotectsearchesbusinessessearchidhitshitidnoteput","openApiOperationId":"complianceKycProtectSearchesBusinessesSearchIdHitsHitIdNotePut","summary":"Update The Note For A Single Businesses Hit"},"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_464","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_464"}},"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/KYCBusinessSearchResultHitSummaryResponse"}},"schemaId":"components/schemas/KYCBusinessSearchResultHitSummaryResponse"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}},"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}},"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1compliance~1kyc-protect~1searches~1businesses~1{searchId}~1hits~1{hitId}~1note/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/KYCBusinessSearchResultHitSummaryResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KYCBusinessSearchResultHitSummaryResponse"}}},{"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":"/aml-screening-businesses/compliancekycprotectsearchesbusinessessearchidhitshitidnoteput"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/searches/businesses/{searchId}/hits/{hitId}/note"},{"label":"Return Business AML Copyrighted Download URL","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-businesses/compliancegetkycsearchesbusinessesssearchidhitshitidsourcessourceidcopyrighteddownload","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-businesses/compliancegetkycsearchesbusinessesssearchidhitshitidsourcessourceidcopyrighteddownload","metadata":{"seo":{"title":"Return Business AML Copyrighted Download URL","description":"Return business aml details copyright evidence report pdf url"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"complianceGetKYCSearchesBusinessessSearchIdHitsHitIdSourcesSourceIdCopyrightedDownload","name":"Return Business AML Copyrighted Download URL","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1searches~1businesses~1{searchId}~1hits~1{hitId}~1sources~1{sourceId}~1copyrighted~1download/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return Business AML Copyrighted Download URL","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Return business aml details copyright evidence report pdf url"},{"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":"searchId","in":"path","schemaId":"schema_387","description":"Id of the search","required":true},{"name":"hitId","in":"path","schemaId":"schema_387","description":"Id of the hit","required":true},{"name":"sourceId","in":"path","schemaId":"schema_387","description":"Id of the hit source","required":true}],"pointer":"/paths/~1compliance~1kyc-protect~1searches~1businesses~1{searchId}~1hits~1{hitId}~1sources~1{sourceId}~1copyrighted~1download/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/compliance/kyc-protect/searches/businesses/{searchId}/hits/{hitId}/sources/{sourceId}/copyrighted/download","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"searchId","in":"path","required":true,"schemaId":"schema_387"},{"name":"hitId","in":"path","required":true,"schemaId":"schema_387"},{"name":"sourceId","in":"path","required":true,"schemaId":"schema_387"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/compliance/kyc-protect/searches/businesses/{searchId}/hits/{hitId}/sources/{sourceId}/copyrighted/download","href":"aml-screening-businesses/compliancegetkycsearchesbusinessesssearchidhitshitidsourcessourceidcopyrighteddownload","openApiOperationId":"complianceGetKYCSearchesBusinessessSearchIdHitsHitIdSourcesSourceIdCopyrightedDownload","summary":"Return Business AML Copyrighted Download URL"},"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/WebApiModelsSearchesBusinessesSearchIdHitsHitIdSourcesSourceIdCopyrightedDownloadResponse"}},"schemaId":"components/schemas/WebApiModelsSearchesBusinessesSearchIdHitsHitIdSourcesSourceIdCopyrightedDownloadResponse"},{"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","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1compliance~1kyc-protect~1searches~1businesses~1{searchId}~1hits~1{hitId}~1sources~1{sourceId}~1copyrighted~1download/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/WebApiModelsSearchesBusinessesSearchIdHitsHitIdSourcesSourceIdCopyrightedDownloadResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebApiModelsSearchesBusinessesSearchIdHitsHitIdSourcesSourceIdCopyrightedDownloadResponse"}}},{"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":"/aml-screening-businesses/compliancegetkycsearchesbusinessesssearchidhitshitidsourcessourceidcopyrighteddownload"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/searches/businesses/{searchId}/hits/{hitId}/sources/{sourceId}/copyrighted/download"},{"label":"Download A PDF File For A Business AML Screening","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-businesses/compliancekycsearchbusinessdownload","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-businesses/compliancekycsearchbusinessdownload","metadata":{"seo":{"title":"Download A PDF File For A Business AML Screening","description":"A request requires a name, at least one valid dataset, at least one valid countrycode and a threshold. Length of name must not exceed 200 characters. User will be deducted 1 credit for each search."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"complianceKycSearchBusinessDownload","name":"Download A PDF File For A Business AML Screening","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1searches~1businesses~1download/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download A PDF File For A Business AML Screening","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"A request requires a name, at least one valid dataset, at least one valid countrycode and a threshold. Length of name must not exceed 200 characters. User will be deducted 1 credit for each search."},{"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_465"}},"schemaId":"schema_465","pointer":"/paths/~1compliance~1kyc-protect~1searches~1businesses~1download/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/compliance/kyc-protect/searches/businesses/download","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_465"}},"responseCodes":["201","400","401","403"],"pointer":"/compliance/kyc-protect/searches/businesses/download","href":"aml-screening-businesses/compliancekycsearchbusinessdownload","openApiOperationId":"complianceKycSearchBusinessDownload","summary":"Download A PDF File For A Business AML Screening"},"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_465","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_465"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KYCGetSearchBusinessesDownloadBySearchIdResponse"}},"schemaId":"components/schemas/KYCGetSearchBusinessesDownloadBySearchIdResponse"},{"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/~1compliance~1kyc-protect~1searches~1businesses~1download/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/KYCGetSearchBusinessesDownloadBySearchIdResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KYCGetSearchBusinessesDownloadBySearchIdResponse"}}},{"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":"/aml-screening-businesses/compliancekycsearchbusinessdownload"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/searches/businesses/download"},{"label":"Return Business Links With Supplier Hit Id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-businesses/complianceprotectgetkycsearchlinksbysupplierhitid","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-businesses/complianceprotectgetkycsearchlinksbysupplierhitid","metadata":{"seo":{"title":"Return Business Links With Supplier Hit Id","description":"Retrieves business links associated with the supplier hit ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"complianceProtectGetKycSearchLinksBySupplierHitId","name":"Return Business Links With Supplier Hit Id","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1searchLinks~1businesses~1{supplierHitId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return Business Links With Supplier Hit Id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves business links associated with the supplier hit 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":"supplierHitId","in":"path","schemaId":"schema_387","description":"The supplier hit id.","required":true,"example":"fb1cff881aebc02e07kmlfdjh7d4393d7745e596b88d4dbd3ece65634630d159e4:618420"}],"pointer":"/paths/~1compliance~1kyc-protect~1searchLinks~1businesses~1{supplierHitId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/compliance/kyc-protect/searchLinks/businesses/{supplierHitId}","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"supplierHitId","in":"path","required":true,"example":"fb1cff881aebc02e07kmlfdjh7d4393d7745e596b88d4dbd3ece65634630d159e4:618420","schemaId":"schema_387"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/compliance/kyc-protect/searchLinks/businesses/{supplierHitId}","href":"aml-screening-businesses/complianceprotectgetkycsearchlinksbysupplierhitid","openApiOperationId":"complianceProtectGetKycSearchLinksBySupplierHitId","summary":"Return Business Links With Supplier Hit 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","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetKYCSearchLinksBySupplierHitId"}},"schemaId":"components/schemas/GetKYCSearchLinksBySupplierHitId"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}},"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1compliance~1kyc-protect~1searchLinks~1businesses~1{supplierHitId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetKYCSearchLinksBySupplierHitId","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetKYCSearchLinksBySupplierHitId"}}},{"code":"401","schemaId":"components/schemas/ConnectErrorResponsesInvalidToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}}},{"code":"404","schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/aml-screening-businesses/complianceprotectgetkycsearchlinksbysupplierhitid"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/searchLinks/businesses/{supplierHitId}"},{"label":"Download Search Links PDF","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-businesses/complianceprotectpostkycsearchlinksbusinessesbysupplierhitiddownload","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-businesses/complianceprotectpostkycsearchlinksbusinessesbysupplierhitiddownload","metadata":{"seo":{"title":"Download Search Links PDF","description":"Download business link as PDF associated with the supplier hit ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"complianceProtectPostKycSearchLinksBusinessesBySupplierHitIdDownload","name":"Download Search Links PDF","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1searchLinks~1businesses~1{supplierHitId}~1download/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download Search Links PDF","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Download business link as PDF associated with the supplier hit 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":"supplierHitId","in":"path","schemaId":"schema_387","description":"The supplier hit id.","required":true,"example":"fb1cff881aebc02e07kmlfdjh7d4393d7745e596b88d4dbd3ece65634630d159e4:618420"}],"pointer":"/paths/~1compliance~1kyc-protect~1searchLinks~1businesses~1{supplierHitId}~1download/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/compliance/kyc-protect/searchLinks/businesses/{supplierHitId}/download","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"supplierHitId","in":"path","required":true,"example":"fb1cff881aebc02e07kmlfdjh7d4393d7745e596b88d4dbd3ece65634630d159e4:618420","schemaId":"schema_387"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/compliance/kyc-protect/searchLinks/businesses/{supplierHitId}/download","href":"aml-screening-businesses/complianceprotectpostkycsearchlinksbusinessesbysupplierhitiddownload","openApiOperationId":"complianceProtectPostKycSearchLinksBusinessesBySupplierHitIdDownload","summary":"Download Search Links PDF"},"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":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetBatchUploadsDownloadErrorsByUploadIdResponse"}},"schemaId":"components/schemas/GetBatchUploadsDownloadErrorsByUploadIdResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}},"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1compliance~1kyc-protect~1searchLinks~1businesses~1{supplierHitId}~1download/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetBatchUploadsDownloadErrorsByUploadIdResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetBatchUploadsDownloadErrorsByUploadIdResponse"}}},{"code":"401","schemaId":"components/schemas/ConnectErrorResponsesInvalidToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}}},{"code":"404","schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/aml-screening-businesses/complianceprotectpostkycsearchlinksbusinessesbysupplierhitiddownload"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/searchLinks/businesses/{supplierHitId}/download"}],"content":{"contentType":"group","meta":{"name":"AML Screening - Businesses"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"AML Screening - Businesses","showPageActions":true},{"nodeType":"markdoc","content":"Endpoints to perform AML screening for businesses, including risk assessments and compliance checks."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/compliance/kyc-protect/searches/businesses","summary":"Execute An AML Search For A Business And Saves The Results To The Database","prefix":{"name":"post","color":"post"},"badges":[],"link":"/aml-screening-businesses/kycsearchbusiness","deprecated":false},{"title":"/compliance/kyc-protect/searches/businesses","summary":"Return Business AML Searches","prefix":{"name":"get","color":"get"},"badges":[],"link":"/aml-screening-businesses/kycsearchbusinessget","deprecated":false},{"title":"/compliance/kyc-protect/searches/businesses","summary":"Update Business AML Searches","prefix":{"name":"put","color":"put"},"badges":[],"link":"/aml-screening-businesses/kycsearchbusinessput","deprecated":false},{"title":"/compliance/kyc-protect/searches/businesses/{searchId}","summary":"Return Business AML Search By Search Id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/aml-screening-businesses/getkycsearchbusinessbysearchid","deprecated":false},{"title":"/compliance/kyc-protect/searches/businesses/{searchId}","summary":"Update A Business AML Search By Search Id","prefix":{"name":"put","color":"put"},"badges":[],"link":"/aml-screening-businesses/putkycsearchbusinessbysearchid","deprecated":false},{"title":"/compliance/kyc-protect/searches/businesses/{searchId}/download","summary":"Download PDF Business Search Report","prefix":{"name":"post","color":"post"},"badges":[],"link":"/aml-screening-businesses/compliancegetkycsearchbusinessdownloadbysearchid","deprecated":false},{"title":"/compliance/kyc-protect/searches/businesses/{searchId}/hits","summary":"Return Business AML Search Hits","prefix":{"name":"get","color":"get"},"badges":[],"link":"/aml-screening-businesses/getkycsearchbusinesshitsbysearchid","deprecated":false},{"title":"/compliance/kyc-protect/searches/businesses/{searchId}/hits","summary":"Update Batch Of Business AML Search Hits","prefix":{"name":"put","color":"put"},"badges":[],"link":"/aml-screening-businesses/putkycsearchbusinesshitsbysearchid","deprecated":false},{"title":"/compliance/kyc-protect/searches/businesses/{searchId}/hits/{hitId}","summary":"Return Full AML Search Hit Information By SearchId And HitId","prefix":{"name":"get","color":"get"},"badges":[],"link":"/aml-screening-businesses/getkycsearchbusinesshitsbysearchidandhitid","deprecated":false},{"title":"/compliance/kyc-protect/searches/businesses/{searchId}/hits/{hitId}","summary":"Update A Single Business Hit","prefix":{"name":"put","color":"put"},"badges":[],"link":"/aml-screening-businesses/putkycsearchbusinessbysearchidandhitid","deprecated":false},{"title":"/compliance/kyc-protect/searches/businesses/{searchId}/hits/{hitId}/download","summary":"Download AML Details for a Hit","prefix":{"name":"get","color":"get"},"badges":[],"link":"/aml-screening-businesses/compliancegetkycsearchbusinesshitsbysearchidandhitiddownload","deprecated":false},{"title":"/compliance/kyc-protect/searches/businesses/{searchId}/hits/{hitId}/note","summary":"Update The Note For A Single Businesses Hit","prefix":{"name":"put","color":"put"},"badges":[],"link":"/aml-screening-businesses/compliancekycprotectsearchesbusinessessearchidhitshitidnoteput","deprecated":false},{"title":"/compliance/kyc-protect/searches/businesses/{searchId}/hits/{hitId}/sources/{sourceId}/copyrighted/download","summary":"Return Business AML Copyrighted Download URL","prefix":{"name":"get","color":"get"},"badges":[],"link":"/aml-screening-businesses/compliancegetkycsearchesbusinessesssearchidhitshitidsourcessourceidcopyrighteddownload","deprecated":false},{"title":"/compliance/kyc-protect/searches/businesses/download","summary":"Download A PDF File For A Business AML Screening","prefix":{"name":"post","color":"post"},"badges":[],"link":"/aml-screening-businesses/compliancekycsearchbusinessdownload","deprecated":false},{"title":"/compliance/kyc-protect/searchLinks/businesses/{supplierHitId}","summary":"Return Business Links With Supplier Hit Id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/aml-screening-businesses/complianceprotectgetkycsearchlinksbysupplierhitid","deprecated":false},{"title":"/compliance/kyc-protect/searchLinks/businesses/{supplierHitId}/download","summary":"Download Search Links PDF","prefix":{"name":"post","color":"post"},"badges":[],"link":"/aml-screening-businesses/complianceprotectpostkycsearchlinksbusinessesbysupplierhitiddownload","deprecated":false}]}]}]}]}},{"type":"group","label":"AML Screening - Individuals","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-individuals","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-individuals","items":[{"label":"Execute An AML Search For An Individual And Save The Results To The Database","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-individuals/compliancekycprotectcreateindividualssearch","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-individuals/compliancekycprotectcreateindividualssearch","metadata":{"seo":{"title":"Execute An AML Search For An Individual And Save The Results To The Database","description":"A request requires a name, or first name and last name, at least one valid dataset and a threshold. Length of name or combination of first name, middle name and last name must not exceed 200 characters. If user is providing first name, middle name and last name combination, the max characters limit includes the formatted name in this format {lastName} {firstName} {middleName}. User will be deducted 1 credit for each search."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"complianceKycProtectCreateIndividualsSearch","name":"Execute An AML Search For An Individual And Save The Results To The Database","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1searches~1individuals/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute An AML Search For An Individual And Save The Results To The Database","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":"A request requires a name, or first name and last name, at least one valid dataset and a threshold."},"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":" Length of name or combination of first name, middle name and last name must not exceed 200 characters. If user is providing first name, middle name and last name combination, the max characters limit includes the formatted name in this format {lastName} {firstName} {middleName}."},"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":" User will be deducted 1 credit for each search."},"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/KYCPostIndividualSearchContract"}},"schemaId":"components/schemas/KYCPostIndividualSearchContract","pointer":"/paths/~1compliance~1kyc-protect~1searches~1individuals/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/compliance/kyc-protect/searches/individuals","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/KYCPostIndividualSearchContract"}},"responseCodes":["201","400","401","403","409"],"pointer":"/compliance/kyc-protect/searches/individuals","href":"aml-screening-individuals/compliancekycprotectcreateindividualssearch","openApiOperationId":"complianceKycProtectCreateIndividualsSearch","summary":"Execute An AML Search For An Individual And Save The Results To The Database"},"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/KYCPostIndividualSearchContract","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/KYCPostIndividualSearchContract"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KycProtectPostPostIndividualSearchResponse"}},"schemaId":"components/schemas/KycProtectPostPostIndividualSearchResponse"},{"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":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}],"pointer":"/paths/~1compliance~1kyc-protect~1searches~1individuals/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/KycProtectPostPostIndividualSearchResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KycProtectPostPostIndividualSearchResponse"}}},{"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":"409","schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/aml-screening-individuals/compliancekycprotectcreateindividualssearch"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/searches/individuals"},{"label":"Return Individual AML Searches","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-individuals/compliancekycprotectgetindividualssearch","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-individuals/compliancekycprotectgetindividualssearch","metadata":{"seo":{"title":"Return Individual AML Searches","description":"Returns a list of individual AML searches ordered by modified date."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"complianceKycProtectGetIndividualsSearch","name":"Return Individual AML Searches","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1searches~1individuals/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return Individual AML Searches","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a list of individual AML searches ordered by modified date."},{"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_398","description":"Starting page number."},{"name":"pageSize","in":"query","schemaId":"schema_388","description":"Specifies the number of items to be displayed per page. Allowed values are between 1 and 100."},{"name":"isScheduled","in":"query","schemaId":"schema_428"}],"pointer":"/paths/~1compliance~1kyc-protect~1searches~1individuals/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/compliance/kyc-protect/searches/individuals","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_398"},{"name":"pageSize","in":"query","schemaId":"schema_388"},{"name":"isScheduled","in":"query","required":false,"schemaId":"schema_428"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403"],"pointer":"/compliance/kyc-protect/searches/individuals","href":"aml-screening-individuals/compliancekycprotectgetindividualssearch","openApiOperationId":"complianceKycProtectGetIndividualsSearch","summary":"Return Individual AML Searches"},"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/KycProtectGetIndividualSearchResponse"}},"schemaId":"components/schemas/KycProtectGetIndividualSearchResponse"},{"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/~1compliance~1kyc-protect~1searches~1individuals/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/KycProtectGetIndividualSearchResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KycProtectGetIndividualSearchResponse"}}},{"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":"/aml-screening-individuals/compliancekycprotectgetindividualssearch"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/searches/individuals"},{"label":"Update Individual AML Searches","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-individuals/compliancekycprotectupdateindividualssearch","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-individuals/compliancekycprotectupdateindividualssearch","metadata":{"seo":{"title":"Update Individual AML Searches","description":"Updates a batch of individual AML searches."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"complianceKycProtectUpdateIndividualsSearch","name":"Update Individual AML Searches","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1searches~1individuals/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Individual AML Searches","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates a batch of individual AML searches."},{"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/PutKYCIndividualSearchRequest"}},"schemaId":"components/schemas/PutKYCIndividualSearchRequest","pointer":"/paths/~1compliance~1kyc-protect~1searches~1individuals/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/compliance/kyc-protect/searches/individuals","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/PutKYCIndividualSearchRequest"}},"responseCodes":["200","400","401","403","409"],"pointer":"/compliance/kyc-protect/searches/individuals","href":"aml-screening-individuals/compliancekycprotectupdateindividualssearch","openApiOperationId":"complianceKycProtectUpdateIndividualsSearch","summary":"Update Individual AML Searches"},"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/PutKYCIndividualSearchRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PutKYCIndividualSearchRequest"}},"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/KYCPUTSearchIndividualResponse"}},"schemaId":"components/schemas/KYCPUTSearchIndividualResponse"},{"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":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}],"pointer":"/paths/~1compliance~1kyc-protect~1searches~1individuals/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/KYCPUTSearchIndividualResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KYCPUTSearchIndividualResponse"}}},{"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":"409","schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/aml-screening-individuals/compliancekycprotectupdateindividualssearch"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/searches/individuals"},{"label":"Return Individual AML Search By Search Id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-individuals/getsanindividualsearchforthecurrentloggedinuserscustomerbasedonsearchid","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-individuals/getsanindividualsearchforthecurrentloggedinuserscustomerbasedonsearchid","metadata":{"seo":{"title":"Return Individual AML Search By Search Id","description":"Returns a single AML Search based on searchId."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getsAnIndividualSearchForTheCurrentLoggedInUsersCustomerBasedOnSearchId","name":"Return Individual AML Search By Search Id","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1searches~1individuals~1{searchId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return Individual AML Search By Search Id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a single AML Search based on searchId."},{"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":"searchId","in":"path","schemaId":"schema_451","description":"search id to fetch","required":true}],"pointer":"/paths/~1compliance~1kyc-protect~1searches~1individuals~1{searchId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/compliance/kyc-protect/searches/individuals/{searchId}","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"searchId","in":"path","required":true,"schemaId":"schema_451"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401"],"pointer":"/compliance/kyc-protect/searches/individuals/{searchId}","href":"aml-screening-individuals/getsanindividualsearchforthecurrentloggedinuserscustomerbasedonsearchid","openApiOperationId":"getsAnIndividualSearchForTheCurrentLoggedInUsersCustomerBasedOnSearchId","summary":"Return Individual AML Search By Search 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","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KYCGetSearchIndividualBySearchIdResponse"}},"schemaId":"components/schemas/KYCGetSearchIndividualBySearchIdResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}},"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}],"pointer":"/paths/~1compliance~1kyc-protect~1searches~1individuals~1{searchId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/KYCGetSearchIndividualBySearchIdResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KYCGetSearchIndividualBySearchIdResponse"}}},{"code":"400","schemaId":"components/schemas/ConnectErrorResponsesBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}}},{"code":"401","schemaId":"components/schemas/ConnectErrorResponsesInvalidToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/aml-screening-individuals/getsanindividualsearchforthecurrentloggedinuserscustomerbasedonsearchid"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/searches/individuals/{searchId}"},{"label":"Update An Individual AML Search By SearchID","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-individuals/updatesanindividualsearch","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-individuals/updatesanindividualsearch","metadata":{"seo":{"title":"Update An Individual AML Search By SearchID","description":"Updates an Individual AML Search by Search Id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updatesAnIndividualSearch","name":"Update An Individual AML Search By SearchID","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1searches~1individuals~1{searchId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update An Individual AML Search By SearchID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates an Individual AML Search by Search 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":"searchId","in":"path","schemaId":"schema_451","description":"search id to update","required":true}],"pointer":"/paths/~1compliance~1kyc-protect~1searches~1individuals~1{searchId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PutKYCIndividualSearchBySearchIdRequest"}},"schemaId":"components/schemas/PutKYCIndividualSearchBySearchIdRequest","pointer":"/paths/~1compliance~1kyc-protect~1searches~1individuals~1{searchId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/compliance/kyc-protect/searches/individuals/{searchId}","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"searchId","in":"path","required":true,"schemaId":"schema_451"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PutKYCIndividualSearchBySearchIdRequest"}},"responseCodes":["200","400","401","404"],"pointer":"/compliance/kyc-protect/searches/individuals/{searchId}","href":"aml-screening-individuals/updatesanindividualsearch","openApiOperationId":"updatesAnIndividualSearch","summary":"Update An Individual AML Search By SearchID"},"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/PutKYCIndividualSearchBySearchIdRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PutKYCIndividualSearchBySearchIdRequest"}},"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/KYCPutSearchIndividualBySearchIdResponse"}},"schemaId":"components/schemas/KYCPutSearchIndividualBySearchIdResponse"},{"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":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1compliance~1kyc-protect~1searches~1individuals~1{searchId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/KYCPutSearchIndividualBySearchIdResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KYCPutSearchIndividualBySearchIdResponse"}}},{"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":"404","schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/aml-screening-individuals/updatesanindividualsearch"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/searches/individuals/{searchId}"},{"label":"Download PDF Business Search Report","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-individuals/compliancegetkycsearchindividualdownloadbysearchid","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-individuals/compliancegetkycsearchindividualdownloadbysearchid","metadata":{"seo":{"title":"Download PDF Business Search Report","description":"Gets an individual search report for the current logged in user's customer based on search id Retrieves data using the POST method to allow inclusion of request payload"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"complianceGetKycSearchIndividualDownloadBySearchId","name":"Download PDF Business Search Report","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1searches~1individuals~1{searchId}~1download/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download PDF Business Search Report","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets an individual search report for the current logged in user's customer based on search id Retrieves data using the POST method to allow inclusion of request payload"},{"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":"searchId","in":"path","schemaId":"schema_387","required":true}],"pointer":"/paths/~1compliance~1kyc-protect~1searches~1individuals~1{searchId}~1download/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_462"}},"schemaId":"schema_462","pointer":"/paths/~1compliance~1kyc-protect~1searches~1individuals~1{searchId}~1download/post/requestBody","description":"Supply a list of hit Id's from the searchId supplied for the PDF to be created."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/compliance/kyc-protect/searches/individuals/{searchId}/download","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"searchId","in":"path","required":true,"schemaId":"schema_387"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_462"}},"responseCodes":["200","400","401","403","404"],"pointer":"/compliance/kyc-protect/searches/individuals/{searchId}/download","href":"aml-screening-individuals/compliancegetkycsearchindividualdownloadbysearchid","openApiOperationId":"complianceGetKycSearchIndividualDownloadBySearchId","summary":"Download PDF Business Search 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"}],"schemaId":"schema_462","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_462"}},"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/KYCGetSearchBusinessesDownloadBySearchIdResponse"}},"schemaId":"components/schemas/KYCGetSearchBusinessesDownloadBySearchIdResponse"},{"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","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1compliance~1kyc-protect~1searches~1individuals~1{searchId}~1download/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/KYCGetSearchBusinessesDownloadBySearchIdResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KYCGetSearchBusinessesDownloadBySearchIdResponse"}}},{"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":"/aml-screening-individuals/compliancegetkycsearchindividualdownloadbysearchid"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/searches/individuals/{searchId}/download"},{"label":"Return Individual AML Search Hits","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-individuals/getstheindividualsearchhits","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-individuals/getstheindividualsearchhits","metadata":{"seo":{"title":"Return Individual AML Search Hits","description":"Returns the individual AML search hits from the AML search results."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getsTheIndividualSearchHits","name":"Return Individual AML Search Hits","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1searches~1individuals~1{searchId}~1hits/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return Individual AML Search Hits","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the individual AML search hits from the AML search results."},{"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":"searchId","in":"path","schemaId":"schema_451","description":"The search identifier.","required":true}],"pointer":"/paths/~1compliance~1kyc-protect~1searches~1individuals~1{searchId}~1hits/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"hitDecisions","in":"query","schemaId":"schema_449","description":"The hit decisions. It can be the collection of undecided, truematch, falsepositive, discarded"},{"name":"page","in":"query","schemaId":"schema_398","description":"Starting page number."},{"name":"pageSize","in":"query","schemaId":"schema_388","description":"Specifies the number of items to be displayed per page. Allowed values are between 1 and 100."}],"pointer":"/paths/~1compliance~1kyc-protect~1searches~1individuals~1{searchId}~1hits/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/compliance/kyc-protect/searches/individuals/{searchId}/hits","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"searchId","in":"path","required":true,"schemaId":"schema_451"}],"query":[{"name":"hitDecisions","in":"query","schemaId":"schema_449"},{"name":"page","in":"query","schemaId":"schema_398"},{"name":"pageSize","in":"query","schemaId":"schema_388"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/compliance/kyc-protect/searches/individuals/{searchId}/hits","href":"aml-screening-individuals/getstheindividualsearchhits","openApiOperationId":"getsTheIndividualSearchHits","summary":"Return Individual AML Search Hits"},"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/GetIndividualSearchIdHitsResponse"}},"schemaId":"components/schemas/GetIndividualSearchIdHitsResponse"},{"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/~1compliance~1kyc-protect~1searches~1individuals~1{searchId}~1hits/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetIndividualSearchIdHitsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetIndividualSearchIdHitsResponse"}}},{"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":"/aml-screening-individuals/getstheindividualsearchhits"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/searches/individuals/{searchId}/hits"},{"label":"Update A Batch Of individual AML search Hits","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-individuals/updatesabatchofindividualhits","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-individuals/updatesabatchofindividualhits","metadata":{"seo":{"title":"Update A Batch Of individual AML search Hits","description":"Update a batch of Individual AML Search Hits."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updatesABatchOfIndividualHits","name":"Update A Batch Of individual AML search Hits","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1searches~1individuals~1{searchId}~1hits/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update A Batch Of individual AML search Hits","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update a batch of Individual AML Search Hits."},{"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":"searchId","in":"path","schemaId":"schema_451","description":"Id of the search","required":true}],"pointer":"/paths/~1compliance~1kyc-protect~1searches~1individuals~1{searchId}~1hits/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/MODEL20274f"}},"schemaId":"components/schemas/MODEL20274f","pointer":"/paths/~1compliance~1kyc-protect~1searches~1individuals~1{searchId}~1hits/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/compliance/kyc-protect/searches/individuals/{searchId}/hits","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"searchId","in":"path","required":true,"schemaId":"schema_451"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/MODEL20274f"}},"responseCodes":["200","400","401","403","404"],"pointer":"/compliance/kyc-protect/searches/individuals/{searchId}/hits","href":"aml-screening-individuals/updatesabatchofindividualhits","openApiOperationId":"updatesABatchOfIndividualHits","summary":"Update A Batch Of individual AML search Hits"},"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/MODEL20274f","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/MODEL20274f"}},"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/PutIndividualSearchIdHitsResponse"}},"schemaId":"components/schemas/PutIndividualSearchIdHitsResponse"},{"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/~1compliance~1kyc-protect~1searches~1individuals~1{searchId}~1hits/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PutIndividualSearchIdHitsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PutIndividualSearchIdHitsResponse"}}},{"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":"/aml-screening-individuals/updatesabatchofindividualhits"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/searches/individuals/{searchId}/hits"},{"label":"Return Full AML Search Hit Information By SearchId And HitId","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-individuals/returnsfullprofileinformationofaindividualhitbyhitid","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-individuals/returnsfullprofileinformationofaindividualhitbyhitid","metadata":{"seo":{"title":"Return Full AML Search Hit Information By SearchId And HitId","description":"This endpoint will return the full hit information by search Id and hitId.  Once this information is requested the information returned is stored to the database as a snap shot of that point in time."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"returnsFullProfileInformationOfAIndividualHitByHitId","name":"Return Full AML Search Hit Information By SearchId And HitId","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1searches~1individuals~1{searchId}~1hits~1{hitId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return Full AML Search Hit Information By SearchId And HitId","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 the full hit information by search Id and hitId. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Once this information is requested the information returned is stored to the database as a snap shot of that point in time."},"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":"searchId","in":"path","schemaId":"schema_451","description":"Id of the search","required":true},{"name":"hitId","in":"path","schemaId":"schema_451","description":"Id of the hit","required":true}],"pointer":"/paths/~1compliance~1kyc-protect~1searches~1individuals~1{searchId}~1hits~1{hitId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/compliance/kyc-protect/searches/individuals/{searchId}/hits/{hitId}","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"searchId","in":"path","required":true,"schemaId":"schema_451"},{"name":"hitId","in":"path","required":true,"schemaId":"schema_451"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/compliance/kyc-protect/searches/individuals/{searchId}/hits/{hitId}","href":"aml-screening-individuals/returnsfullprofileinformationofaindividualhitbyhitid","openApiOperationId":"returnsFullProfileInformationOfAIndividualHitByHitId","summary":"Return Full AML Search Hit Information By SearchId And HitId"},"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/IndividualSearchResultHitResponse"}},"schemaId":"components/schemas/IndividualSearchResultHitResponse"},{"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/~1compliance~1kyc-protect~1searches~1individuals~1{searchId}~1hits~1{hitId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/IndividualSearchResultHitResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/IndividualSearchResultHitResponse"}}},{"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":"/aml-screening-individuals/returnsfullprofileinformationofaindividualhitbyhitid"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/searches/individuals/{searchId}/hits/{hitId}"},{"label":"Update A Single Individual Hit","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-individuals/updatesingleindividualhit","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-individuals/updatesingleindividualhit","metadata":{"seo":{"title":"Update A Single Individual Hit","description":"This endpoint will update a single individual AML search hit by searchId and hitId."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateSingleIndividualHit","name":"Update A Single Individual Hit","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1searches~1individuals~1{searchId}~1hits~1{hitId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update A Single Individual Hit","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 a single individual AML search hit by searchId and hitId."},{"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":"searchId","in":"path","schemaId":"schema_451","description":"Id of the search","required":true},{"name":"hitId","in":"path","schemaId":"schema_451","description":"Id of the hit","required":true}],"pointer":"/paths/~1compliance~1kyc-protect~1searches~1individuals~1{searchId}~1hits~1{hitId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/IndividualsSearchResultUpdateHits"}},"schemaId":"components/schemas/IndividualsSearchResultUpdateHits","pointer":"/paths/~1compliance~1kyc-protect~1searches~1individuals~1{searchId}~1hits~1{hitId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/compliance/kyc-protect/searches/individuals/{searchId}/hits/{hitId}","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"searchId","in":"path","required":true,"schemaId":"schema_451"},{"name":"hitId","in":"path","required":true,"schemaId":"schema_451"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/IndividualsSearchResultUpdateHits"}},"responseCodes":["200","400","401","403","404","409"],"pointer":"/compliance/kyc-protect/searches/individuals/{searchId}/hits/{hitId}","href":"aml-screening-individuals/updatesingleindividualhit","openApiOperationId":"updateSingleIndividualHit","summary":"Update A Single Individual Hit"},"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/IndividualsSearchResultUpdateHits","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/IndividualsSearchResultUpdateHits"}},"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/PutIndividualSearchIdHitsByHitIdResponse"}},"schemaId":"components/schemas/PutIndividualSearchIdHitsByHitIdResponse"},{"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":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}],"pointer":"/paths/~1compliance~1kyc-protect~1searches~1individuals~1{searchId}~1hits~1{hitId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PutIndividualSearchIdHitsByHitIdResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PutIndividualSearchIdHitsByHitIdResponse"}}},{"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":"409","schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/aml-screening-individuals/updatesingleindividualhit"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/searches/individuals/{searchId}/hits/{hitId}"},{"label":"Download AML Details for a Hit","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-individuals/compliancegetkycsearchindividualhitsbysearchidandhitiddownload","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-individuals/compliancegetkycsearchindividualhitsbysearchidandhitiddownload","metadata":{"seo":{"title":"Download AML Details for a Hit","description":"Retrieves the download URL and metadata for the AML details PDF associated with a specific hit  within an individual search.  Use this endpoint to obtain the PDF file containing detailed AML information for a flagged  result (hitId) from a previously performed search (searchId). The response includes the  download URL, file name, expiration timestamp, and identifiers for the search and hit."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"complianceGetKycSearchIndividualHitsBySearchIdAndHitIdDownload","name":"Download AML Details for a Hit","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1searches~1individuals~1{searchId}~1hits~1{hitId}~1download/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download AML Details for a Hit","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 the download URL and metadata for the AML details PDF associated with a specific hit  within an individual search. "},"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":" Use this endpoint to obtain the PDF file containing detailed AML information for a flagged  result ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hitId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") from a previously performed search ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"searchId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). The response includes the  download URL, file name, expiration timestamp, and identifiers for the search and hit."},"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":"searchId","in":"path","schemaId":"schema_451","description":"The unique identifier of the search that generated the hit. This ID links the request  to the specific search performed in the KYC Protect system.\n","required":true},{"name":"hitId","in":"path","schemaId":"schema_451","description":"The unique identifier of the hit associated with the search. This ID is used to retrieve  the specific details of a flagged result from the search.\n","required":true}],"pointer":"/paths/~1compliance~1kyc-protect~1searches~1individuals~1{searchId}~1hits~1{hitId}~1download/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/compliance/kyc-protect/searches/individuals/{searchId}/hits/{hitId}/download","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"searchId","in":"path","required":true,"schemaId":"schema_451"},{"name":"hitId","in":"path","required":true,"schemaId":"schema_451"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/compliance/kyc-protect/searches/individuals/{searchId}/hits/{hitId}/download","href":"aml-screening-individuals/compliancegetkycsearchindividualhitsbysearchidandhitiddownload","openApiOperationId":"complianceGetKycSearchIndividualHitsBySearchIdAndHitIdDownload","summary":"Download AML Details for a Hit"},"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/WebApiModelsSearchesSearchResultHitsBusinessSearchHitAttachmentLinkResponse"}},"schemaId":"components/schemas/WebApiModelsSearchesSearchResultHitsBusinessSearchHitAttachmentLinkResponse"},{"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","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1compliance~1kyc-protect~1searches~1individuals~1{searchId}~1hits~1{hitId}~1download/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/WebApiModelsSearchesSearchResultHitsBusinessSearchHitAttachmentLinkResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebApiModelsSearchesSearchResultHitsBusinessSearchHitAttachmentLinkResponse"}}},{"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":"/aml-screening-individuals/compliancegetkycsearchindividualhitsbysearchidandhitiddownload"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/searches/individuals/{searchId}/hits/{hitId}/download"},{"label":"Update The Note For A Single Individuals Hit","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-individuals/compliancekycprotectsearchesindividualssearchidhitshitidnoteput","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-individuals/compliancekycprotectsearchesindividualssearchidhitshitidnoteput","metadata":{"seo":{"title":"Update The Note For A Single Individuals Hit","description":"Update The Note For A Single Individuals Hit"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"complianceKycProtectSearchesIndividualsSearchIdHitsHitIdNotePut","name":"Update The Note For A Single Individuals Hit","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1searches~1individuals~1{searchId}~1hits~1{hitId}~1note/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update The Note For A Single Individuals Hit","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"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":"searchId","in":"path","schemaId":"schema_451","description":"Id of the search","required":true},{"name":"hitId","in":"path","schemaId":"schema_451","description":"Id of the hit","required":true}],"pointer":"/paths/~1compliance~1kyc-protect~1searches~1individuals~1{searchId}~1hits~1{hitId}~1note/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/IndividualsSearchNoteResultUpdatetHits"}},"schemaId":"components/schemas/IndividualsSearchNoteResultUpdatetHits","pointer":"/paths/~1compliance~1kyc-protect~1searches~1individuals~1{searchId}~1hits~1{hitId}~1note/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/compliance/kyc-protect/searches/individuals/{searchId}/hits/{hitId}/note","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"searchId","in":"path","required":true,"schemaId":"schema_451"},{"name":"hitId","in":"path","required":true,"schemaId":"schema_451"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/IndividualsSearchNoteResultUpdatetHits"}},"responseCodes":["200","400","401","403","404","409"],"pointer":"/compliance/kyc-protect/searches/individuals/{searchId}/hits/{hitId}/note","href":"aml-screening-individuals/compliancekycprotectsearchesindividualssearchidhitshitidnoteput","openApiOperationId":"complianceKycProtectSearchesIndividualsSearchIdHitsHitIdNotePut","summary":"Update The Note For A Single Individuals Hit"},"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/IndividualsSearchNoteResultUpdatetHits","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/IndividualsSearchNoteResultUpdatetHits"}},"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/PutIndividualSearchIdHitsByHitIdResponse"}},"schemaId":"components/schemas/PutIndividualSearchIdHitsByHitIdResponse"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}},"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}},"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}],"pointer":"/paths/~1compliance~1kyc-protect~1searches~1individuals~1{searchId}~1hits~1{hitId}~1note/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PutIndividualSearchIdHitsByHitIdResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PutIndividualSearchIdHitsByHitIdResponse"}}},{"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":"409","schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/aml-screening-individuals/compliancekycprotectsearchesindividualssearchidhitshitidnoteput"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/searches/individuals/{searchId}/hits/{hitId}/note"},{"label":"Return Individual AML Copyrighted Download URL","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-individuals/compliancegetkycsearchesindividualssearchidhitshitidsourcessourceidcopyrighteddownload","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-individuals/compliancegetkycsearchesindividualssearchidhitshitidsourcessourceidcopyrighteddownload","metadata":{"seo":{"title":"Return Individual AML Copyrighted Download URL","description":"Return individual aml details copyright evidence report pdf url"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"complianceGetKYCSearchesIndividualsSearchIdHitsHitIdSourcesSourceIdCopyrightedDownload","name":"Return Individual AML Copyrighted Download URL","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1searches~1individuals~1{searchId}~1hits~1{hitId}~1sources~1{sourceId}~1copyrighted~1download/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return Individual AML Copyrighted Download URL","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Return individual aml details copyright evidence report pdf url"},{"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":"searchId","in":"path","schemaId":"schema_387","description":"Id of the search","required":true},{"name":"hitId","in":"path","schemaId":"schema_387","description":"Id of the hit","required":true},{"name":"sourceId","in":"path","schemaId":"schema_387","description":"Id of the hit source","required":true}],"pointer":"/paths/~1compliance~1kyc-protect~1searches~1individuals~1{searchId}~1hits~1{hitId}~1sources~1{sourceId}~1copyrighted~1download/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/compliance/kyc-protect/searches/individuals/{searchId}/hits/{hitId}/sources/{sourceId}/copyrighted/download","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"searchId","in":"path","required":true,"schemaId":"schema_387"},{"name":"hitId","in":"path","required":true,"schemaId":"schema_387"},{"name":"sourceId","in":"path","required":true,"schemaId":"schema_387"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/compliance/kyc-protect/searches/individuals/{searchId}/hits/{hitId}/sources/{sourceId}/copyrighted/download","href":"aml-screening-individuals/compliancegetkycsearchesindividualssearchidhitshitidsourcessourceidcopyrighteddownload","openApiOperationId":"complianceGetKYCSearchesIndividualsSearchIdHitsHitIdSourcesSourceIdCopyrightedDownload","summary":"Return Individual AML Copyrighted Download URL"},"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/WebApiModelsSearchesBusinessesSearchIdHitsHitIdSourcesSourceIdCopyrightedDownloadResponse"}},"schemaId":"components/schemas/WebApiModelsSearchesBusinessesSearchIdHitsHitIdSourcesSourceIdCopyrightedDownloadResponse"},{"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","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1compliance~1kyc-protect~1searches~1individuals~1{searchId}~1hits~1{hitId}~1sources~1{sourceId}~1copyrighted~1download/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/WebApiModelsSearchesBusinessesSearchIdHitsHitIdSourcesSourceIdCopyrightedDownloadResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebApiModelsSearchesBusinessesSearchIdHitsHitIdSourcesSourceIdCopyrightedDownloadResponse"}}},{"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":"/aml-screening-individuals/compliancegetkycsearchesindividualssearchidhitshitidsourcessourceidcopyrighteddownload"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/searches/individuals/{searchId}/hits/{hitId}/sources/{sourceId}/copyrighted/download"},{"label":"Download A PDF File For An Individual AML Screening","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-individuals/compliancekycsearchindividualdownload","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-individuals/compliancekycsearchindividualdownload","metadata":{"seo":{"title":"Download A PDF File For An Individual AML Screening","description":"A request requires a name, or first name and last name, at least one valid dataset, at least one valid countrycode and a threshold. Length of name or combination of first name, middle name and last name must not exceed 200 characters. If user is providing first name, middle name and last name combination, the max characters limit includes the formatted name in this format lastname, firstname middlename. User will be deducted 1 credit for each search."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"complianceKycSearchIndividualDownload","name":"Download A PDF File For An Individual AML Screening","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1searches~1individuals~1download/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download A PDF File For An Individual AML Screening","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"A request requires a name, or first name and last name, at least one valid dataset, at least one valid countrycode and a threshold. Length of name or combination of first name, middle name and last name must not exceed 200 characters. If user is providing first name, middle name and last name combination, the max characters limit includes the formatted name in this format lastname, firstname middlename. User will be deducted 1 credit for each search."},{"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_466"}},"schemaId":"schema_466","pointer":"/paths/~1compliance~1kyc-protect~1searches~1individuals~1download/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/compliance/kyc-protect/searches/individuals/download","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_466"}},"responseCodes":["201","400","401","403"],"pointer":"/compliance/kyc-protect/searches/individuals/download","href":"aml-screening-individuals/compliancekycsearchindividualdownload","openApiOperationId":"complianceKycSearchIndividualDownload","summary":"Download A PDF File For An Individual AML Screening"},"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_466","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_466"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KYCGetSearchBusinessesDownloadBySearchIdResponse"}},"schemaId":"components/schemas/KYCGetSearchBusinessesDownloadBySearchIdResponse"},{"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/~1compliance~1kyc-protect~1searches~1individuals~1download/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/KYCGetSearchBusinessesDownloadBySearchIdResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KYCGetSearchBusinessesDownloadBySearchIdResponse"}}},{"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":"/aml-screening-individuals/compliancekycsearchindividualdownload"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/searches/individuals/download"},{"label":"Return Search Links By Supplier Hit Id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-individuals/complianceprotectgetkycsearchindividuallinksbysupplierhitid","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-individuals/complianceprotectgetkycsearchindividuallinksbysupplierhitid","metadata":{"seo":{"title":"Return Search Links By Supplier Hit Id","description":"Retrieves individual links associated with the supplier hit ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"complianceProtectGetKycSearchIndividualLinksBySupplierHitId","name":"Return Search Links By Supplier Hit Id","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1searchLinks~1individuals~1{supplierHitId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return Search Links By Supplier Hit Id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves individual links associated with the supplier hit 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":"supplierHitId","in":"path","schemaId":"schema_387","description":"The supplier hit id.","required":true,"example":"fb1cff881aebc02e07kmlfdjh7d4393d7745e596b88d4dbd3ece65634630d159e4:618420"}],"pointer":"/paths/~1compliance~1kyc-protect~1searchLinks~1individuals~1{supplierHitId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/compliance/kyc-protect/searchLinks/individuals/{supplierHitId}","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"supplierHitId","in":"path","required":true,"example":"fb1cff881aebc02e07kmlfdjh7d4393d7745e596b88d4dbd3ece65634630d159e4:618420","schemaId":"schema_387"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/compliance/kyc-protect/searchLinks/individuals/{supplierHitId}","href":"aml-screening-individuals/complianceprotectgetkycsearchindividuallinksbysupplierhitid","openApiOperationId":"complianceProtectGetKycSearchIndividualLinksBySupplierHitId","summary":"Return Search Links By Supplier Hit 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","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetKYCSearchLinksBySupplierHitId"}},"schemaId":"components/schemas/GetKYCSearchLinksBySupplierHitId"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}},"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1compliance~1kyc-protect~1searchLinks~1individuals~1{supplierHitId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetKYCSearchLinksBySupplierHitId","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetKYCSearchLinksBySupplierHitId"}}},{"code":"401","schemaId":"components/schemas/ConnectErrorResponsesInvalidToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}}},{"code":"404","schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/aml-screening-individuals/complianceprotectgetkycsearchindividuallinksbysupplierhitid"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/searchLinks/individuals/{supplierHitId}"},{"label":"Download Search Links PDF","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-individuals/complianceprotectpostkycsearchlinksindividualsbysupplierhitiddownload","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-individuals/complianceprotectpostkycsearchlinksindividualsbysupplierhitiddownload","metadata":{"seo":{"title":"Download Search Links PDF","description":"Download individual link as PDF associated with the supplier hit ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"complianceProtectPostKycSearchLinksIndividualsBySupplierHitIdDownload","name":"Download Search Links PDF","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1searchLinks~1individuals~1{supplierHitId}~1download/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download Search Links PDF","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Download individual link as PDF associated with the supplier hit 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":"supplierHitId","in":"path","schemaId":"schema_387","description":"The supplier hit id.","required":true,"example":"fb1cff881aebc02e07kmlfdjh7d4393d7745e596b88d4dbd3ece65634630d159e4:618420"}],"pointer":"/paths/~1compliance~1kyc-protect~1searchLinks~1individuals~1{supplierHitId}~1download/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/compliance/kyc-protect/searchLinks/individuals/{supplierHitId}/download","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"supplierHitId","in":"path","required":true,"example":"fb1cff881aebc02e07kmlfdjh7d4393d7745e596b88d4dbd3ece65634630d159e4:618420","schemaId":"schema_387"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/compliance/kyc-protect/searchLinks/individuals/{supplierHitId}/download","href":"aml-screening-individuals/complianceprotectpostkycsearchlinksindividualsbysupplierhitiddownload","openApiOperationId":"complianceProtectPostKycSearchLinksIndividualsBySupplierHitIdDownload","summary":"Download Search Links PDF"},"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":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetBatchUploadsDownloadErrorsByUploadIdResponse"}},"schemaId":"components/schemas/GetBatchUploadsDownloadErrorsByUploadIdResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}},"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1compliance~1kyc-protect~1searchLinks~1individuals~1{supplierHitId}~1download/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetBatchUploadsDownloadErrorsByUploadIdResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetBatchUploadsDownloadErrorsByUploadIdResponse"}}},{"code":"401","schemaId":"components/schemas/ConnectErrorResponsesInvalidToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}}},{"code":"404","schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/aml-screening-individuals/complianceprotectpostkycsearchlinksindividualsbysupplierhitiddownload"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/searchLinks/individuals/{supplierHitId}/download"}],"content":{"contentType":"group","meta":{"name":"AML Screening - Individuals"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"AML Screening - Individuals","showPageActions":true},{"nodeType":"markdoc","content":"Endpoints to perform AML screening for individuals, including identity verification and risk assessments."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/compliance/kyc-protect/searches/individuals","summary":"Execute An AML Search For An Individual And Save The Results To The Database","prefix":{"name":"post","color":"post"},"badges":[],"link":"/aml-screening-individuals/compliancekycprotectcreateindividualssearch","deprecated":false},{"title":"/compliance/kyc-protect/searches/individuals","summary":"Return Individual AML Searches","prefix":{"name":"get","color":"get"},"badges":[],"link":"/aml-screening-individuals/compliancekycprotectgetindividualssearch","deprecated":false},{"title":"/compliance/kyc-protect/searches/individuals","summary":"Update Individual AML Searches","prefix":{"name":"put","color":"put"},"badges":[],"link":"/aml-screening-individuals/compliancekycprotectupdateindividualssearch","deprecated":false},{"title":"/compliance/kyc-protect/searches/individuals/{searchId}","summary":"Return Individual AML Search By Search Id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/aml-screening-individuals/getsanindividualsearchforthecurrentloggedinuserscustomerbasedonsearchid","deprecated":false},{"title":"/compliance/kyc-protect/searches/individuals/{searchId}","summary":"Update An Individual AML Search By SearchID","prefix":{"name":"put","color":"put"},"badges":[],"link":"/aml-screening-individuals/updatesanindividualsearch","deprecated":false},{"title":"/compliance/kyc-protect/searches/individuals/{searchId}/download","summary":"Download PDF Business Search Report","prefix":{"name":"post","color":"post"},"badges":[],"link":"/aml-screening-individuals/compliancegetkycsearchindividualdownloadbysearchid","deprecated":false},{"title":"/compliance/kyc-protect/searches/individuals/{searchId}/hits","summary":"Return Individual AML Search Hits","prefix":{"name":"get","color":"get"},"badges":[],"link":"/aml-screening-individuals/getstheindividualsearchhits","deprecated":false},{"title":"/compliance/kyc-protect/searches/individuals/{searchId}/hits","summary":"Update A Batch Of individual AML search Hits","prefix":{"name":"put","color":"put"},"badges":[],"link":"/aml-screening-individuals/updatesabatchofindividualhits","deprecated":false},{"title":"/compliance/kyc-protect/searches/individuals/{searchId}/hits/{hitId}","summary":"Return Full AML Search Hit Information By SearchId And HitId","prefix":{"name":"get","color":"get"},"badges":[],"link":"/aml-screening-individuals/returnsfullprofileinformationofaindividualhitbyhitid","deprecated":false},{"title":"/compliance/kyc-protect/searches/individuals/{searchId}/hits/{hitId}","summary":"Update A Single Individual Hit","prefix":{"name":"put","color":"put"},"badges":[],"link":"/aml-screening-individuals/updatesingleindividualhit","deprecated":false},{"title":"/compliance/kyc-protect/searches/individuals/{searchId}/hits/{hitId}/download","summary":"Download AML Details for a Hit","prefix":{"name":"get","color":"get"},"badges":[],"link":"/aml-screening-individuals/compliancegetkycsearchindividualhitsbysearchidandhitiddownload","deprecated":false},{"title":"/compliance/kyc-protect/searches/individuals/{searchId}/hits/{hitId}/note","summary":"Update The Note For A Single Individuals Hit","prefix":{"name":"put","color":"put"},"badges":[],"link":"/aml-screening-individuals/compliancekycprotectsearchesindividualssearchidhitshitidnoteput","deprecated":false},{"title":"/compliance/kyc-protect/searches/individuals/{searchId}/hits/{hitId}/sources/{sourceId}/copyrighted/download","summary":"Return Individual AML Copyrighted Download URL","prefix":{"name":"get","color":"get"},"badges":[],"link":"/aml-screening-individuals/compliancegetkycsearchesindividualssearchidhitshitidsourcessourceidcopyrighteddownload","deprecated":false},{"title":"/compliance/kyc-protect/searches/individuals/download","summary":"Download A PDF File For An Individual AML Screening","prefix":{"name":"post","color":"post"},"badges":[],"link":"/aml-screening-individuals/compliancekycsearchindividualdownload","deprecated":false},{"title":"/compliance/kyc-protect/searchLinks/individuals/{supplierHitId}","summary":"Return Search Links By Supplier Hit Id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/aml-screening-individuals/complianceprotectgetkycsearchindividuallinksbysupplierhitid","deprecated":false},{"title":"/compliance/kyc-protect/searchLinks/individuals/{supplierHitId}/download","summary":"Download Search Links PDF","prefix":{"name":"post","color":"post"},"badges":[],"link":"/aml-screening-individuals/complianceprotectpostkycsearchlinksindividualsbysupplierhitiddownload","deprecated":false}]}]}]}]}},{"type":"group","label":"AML Screening - Profile Management","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-profile-management","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-profile-management","items":[{"label":"Return All Hits Linked To The Profile","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-profile-management/kycprotectgetamlalertsbyprofileid","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-profile-management/kycprotectgetamlalertsbyprofileid","metadata":{"seo":{"title":"Return All Hits Linked To The Profile","description":"Returns hits of all searches linked to the profile and key parties."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"kycProtectGetAmlAlertsByProfileId","name":"Return All Hits Linked To The Profile","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1amlAlerts/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return All Hits Linked To The Profile","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns hits of all searches linked to the profile and key parties."},{"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":"profileId","in":"path","schemaId":"schema_451","description":"id of the profile","required":true}],"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1amlAlerts/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_398","description":"Starting page number."},{"name":"pageSize","in":"query","schemaId":"schema_388","description":"Specifies the number of items to be displayed per page. Allowed values are between 1 and 100."},{"name":"hitDecisions","in":"query","schemaId":"schema_449","description":"The hit decisions to filter by. It can be the collection of undecided, truematch, falsepositive, discarded"}],"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1amlAlerts/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/compliance/kyc-protect/profiles/{profileId}/amlAlerts","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"schemaId":"schema_451"}],"query":[{"name":"page","in":"query","schemaId":"schema_398"},{"name":"pageSize","in":"query","schemaId":"schema_388"},{"name":"hitDecisions","in":"query","schemaId":"schema_449"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409"],"pointer":"/compliance/kyc-protect/profiles/{profileId}/amlAlerts","href":"aml-screening-profile-management/kycprotectgetamlalertsbyprofileid","openApiOperationId":"kycProtectGetAmlAlertsByProfileId","summary":"Return All Hits Linked To The Profile"},"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":"schema_467"}},"schemaId":"schema_467"},{"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":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}],"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1amlAlerts/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_467","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_467"}}},{"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":"409","schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/aml-screening-profile-management/kycprotectgetamlalertsbyprofileid"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/profiles/{profileId}/amlAlerts"},{"label":"Return All Hits Of Searches Linked To A Profile","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-profile-management/getkychitsofthesearcheslinkedtoprofile","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-profile-management/getkychitsofthesearcheslinkedtoprofile","metadata":{"seo":{"title":"Return All Hits Of Searches Linked To A Profile","description":"Return hits of the searches linked to a profile."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getKycHitsOfTheSearchesLinkedToProfile","name":"Return All Hits Of Searches Linked To A Profile","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1hits/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return All Hits Of Searches Linked To A Profile","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Return hits of the searches linked to a profile."},{"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":"profileId","in":"path","schemaId":"schema_387","description":"Id of the profile","required":true}],"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1hits/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"hitDecisions","in":"query","schemaId":"schema_449","description":"The hit decisions. It can be the collection of undecided, truematch, falsepositive, discarded"},{"name":"page","in":"query","schemaId":"schema_398","description":"Starting page number."},{"name":"pageSize","in":"query","schemaId":"schema_388","description":"Specifies the number of items to be displayed per page. Allowed values are between 1 and 100."}],"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1hits/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/compliance/kyc-protect/profiles/{profileId}/hits","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"schemaId":"schema_387"}],"query":[{"name":"hitDecisions","in":"query","required":false,"schemaId":"schema_449"},{"name":"page","in":"query","schemaId":"schema_398"},{"name":"pageSize","in":"query","schemaId":"schema_388"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/compliance/kyc-protect/profiles/{profileId}/hits","href":"aml-screening-profile-management/getkychitsofthesearcheslinkedtoprofile","openApiOperationId":"getKycHitsOfTheSearchesLinkedToProfile","summary":"Return All Hits Of Searches Linked To A Profile"},"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/GetProfileHitsByProfileIdResponse"}},"schemaId":"components/schemas/GetProfileHitsByProfileIdResponse"},{"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/~1compliance~1kyc-protect~1profiles~1{profileId}~1hits/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetProfileHitsByProfileIdResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetProfileHitsByProfileIdResponse"}}},{"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":"/aml-screening-profile-management/getkychitsofthesearcheslinkedtoprofile"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/profiles/{profileId}/hits"},{"label":"Return All Schedules By ProfileId And Modified Date","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-profile-management/kycprotectgetprofileschedules","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-profile-management/kycprotectgetprofileschedules","metadata":{"seo":{"title":"Return All Schedules By ProfileId And Modified Date","description":"Returns all schedules based on profileId ordered by modified date."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"kycProtectGetProfileSchedules","name":"Return All Schedules By ProfileId And Modified Date","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1schedules/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return All Schedules By ProfileId And Modified Date","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns all schedules based on profileId ordered by modified date."},{"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":"profileId","in":"path","schemaId":"schema_451","description":"id of the profile","required":true}],"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1schedules/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_398","description":"Starting page number."},{"name":"pageSize","in":"query","schemaId":"schema_388","description":"Specifies the number of items to be displayed per page. Allowed values are between 1 and 100."}],"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1schedules/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/compliance/kyc-protect/profiles/{profileId}/schedules","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"schemaId":"schema_451"}],"query":[{"name":"page","in":"query","schemaId":"schema_398"},{"name":"pageSize","in":"query","schemaId":"schema_388"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/compliance/kyc-protect/profiles/{profileId}/schedules","href":"aml-screening-profile-management/kycprotectgetprofileschedules","openApiOperationId":"kycProtectGetProfileSchedules","summary":"Return All Schedules By ProfileId And Modified Date"},"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/KYCProfileScheduleResponse"}},"schemaId":"components/schemas/KYCProfileScheduleResponse"},{"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","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1schedules/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/KYCProfileScheduleResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KYCProfileScheduleResponse"}}},{"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":"/aml-screening-profile-management/kycprotectgetprofileschedules"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/profiles/{profileId}/schedules"},{"label":"Return Schedule By ProfileId And ScheduleId","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-profile-management/kycprotectgetprofileschedulesbyscheduleid","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-profile-management/kycprotectgetprofileschedulesbyscheduleid","metadata":{"seo":{"title":"Return Schedule By ProfileId And ScheduleId","description":"Returns a schedule by profileId and scheduleId."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"kycProtectGetProfileSchedulesByScheduleId","name":"Return Schedule By ProfileId And ScheduleId","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1schedules~1{scheduleId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return Schedule By ProfileId And ScheduleId","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a schedule by profileId and scheduleId."},{"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":"profileId","in":"path","schemaId":"schema_451","description":"id of the profile","required":true},{"name":"scheduleId","in":"path","schemaId":"schema_387","description":"id of the schedule","required":true}],"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1schedules~1{scheduleId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/compliance/kyc-protect/profiles/{profileId}/schedules/{scheduleId}","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"schemaId":"schema_451"},{"name":"scheduleId","in":"path","required":true,"schemaId":"schema_387"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403"],"pointer":"/compliance/kyc-protect/profiles/{profileId}/schedules/{scheduleId}","href":"aml-screening-profile-management/kycprotectgetprofileschedulesbyscheduleid","openApiOperationId":"kycProtectGetProfileSchedulesByScheduleId","summary":"Return Schedule By ProfileId And ScheduleId"},"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/KYCProfileIdSchedulesScheduleIdResponse"}},"schemaId":"components/schemas/KYCProfileIdSchedulesScheduleIdResponse"},{"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/~1compliance~1kyc-protect~1profiles~1{profileId}~1schedules~1{scheduleId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/KYCProfileIdSchedulesScheduleIdResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KYCProfileIdSchedulesScheduleIdResponse"}}},{"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":"/aml-screening-profile-management/kycprotectgetprofileschedulesbyscheduleid"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/profiles/{profileId}/schedules/{scheduleId}"},{"label":"Return List Of AML Searches On The Given Profile","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-profile-management/kycprotectgetslistofsearchesonthegivenprofile","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-profile-management/kycprotectgetslistofsearchesonthegivenprofile","metadata":{"seo":{"title":"Return List Of AML Searches On The Given Profile","description":"Returns a list of searches both business and individual associated to the profile for the profile Id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"kycProtectGetsListOfSearchesOnTheGivenProfile","name":"Return List Of AML Searches On The Given Profile","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1searches/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return List Of AML Searches On The Given Profile","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a list of searches both business and individual associated to the profile for the profile 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":"profileId","in":"path","schemaId":"schema_451","description":"id of the profile","required":true}],"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1searches/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_398","description":"Starting page number."},{"name":"pageSize","in":"query","schemaId":"schema_388","description":"Specifies the number of items to be displayed per page. Allowed values are between 1 and 100."},{"name":"isScheduled","in":"query","schemaId":"schema_428"}],"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1searches/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/compliance/kyc-protect/profiles/{profileId}/searches","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"schemaId":"schema_451"}],"query":[{"name":"page","in":"query","schemaId":"schema_398"},{"name":"pageSize","in":"query","schemaId":"schema_388"},{"name":"isScheduled","in":"query","schemaId":"schema_428"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/compliance/kyc-protect/profiles/{profileId}/searches","href":"aml-screening-profile-management/kycprotectgetslistofsearchesonthegivenprofile","openApiOperationId":"kycProtectGetsListOfSearchesOnTheGivenProfile","summary":"Return List Of AML Searches On The Given Profile"},"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":"schema_468"}},"schemaId":"schema_468"},{"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/~1compliance~1kyc-protect~1profiles~1{profileId}~1searches/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_468","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_468"}}},{"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":"/aml-screening-profile-management/kycprotectgetslistofsearchesonthegivenprofile"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/profiles/{profileId}/searches"},{"label":"Delete AML searches linked to a profile","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-profile-management/deletekycprofilesearchesbyprofileid","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-profile-management/deletekycprofilesearchesbyprofileid","metadata":{"seo":{"title":"Delete AML searches linked to a profile","description":"Deletes AML searches from a profile by profile Id and Search Id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteKycProfileSearchesByProfileId","name":"Delete AML searches linked to a profile","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1searches/delete","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete AML searches linked to a profile","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes AML searches from a profile by profile Id and Search 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":"profileId","in":"path","schemaId":"schema_387","description":"Id of a profile.","required":true,"example":"9a7ae0c8-f473-4ab6-8dbb-03fc061630cc"}],"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1searches/delete/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DeleteKYCProfileSearchesByProfileIdRequestBody"}},"schemaId":"components/schemas/DeleteKYCProfileSearchesByProfileIdRequestBody","pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1searches/delete/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/compliance/kyc-protect/profiles/{profileId}/searches","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"example":"9a7ae0c8-f473-4ab6-8dbb-03fc061630cc","schemaId":"schema_387"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/DeleteKYCProfileSearchesByProfileIdRequestBody"}},"responseCodes":["200","400","401","403","404","409"],"pointer":"/compliance/kyc-protect/profiles/{profileId}/searches","href":"aml-screening-profile-management/deletekycprofilesearchesbyprofileid","openApiOperationId":"deleteKycProfileSearchesByProfileId","summary":"Delete AML searches linked to a profile"},"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/DeleteKYCProfileSearchesByProfileIdRequestBody","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DeleteKYCProfileSearchesByProfileIdRequestBody"}},"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/DeleteKYCProfileSearchesByProfileIdResponse"}},"schemaId":"components/schemas/DeleteKYCProfileSearchesByProfileIdResponse"},{"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":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}],"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1searches/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/DeleteKYCProfileSearchesByProfileIdResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DeleteKYCProfileSearchesByProfileIdResponse"}}},{"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":"409","schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/aml-screening-profile-management/deletekycprofilesearchesbyprofileid"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/profiles/{profileId}/searches"},{"label":"Add AML Searches To The Given Profile","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-profile-management/kycprotectaddsasearchtothegivenprofile","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-profile-management/kycprotectaddsasearchtothegivenprofile","metadata":{"seo":{"title":"Add AML Searches To The Given Profile","description":"Adds a list of searches to a profile."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"kycProtectAddsASearchToTheGivenProfile","name":"Add AML Searches To The Given Profile","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1searches~1link/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add AML Searches To The Given Profile","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Adds a list of searches to a profile."},{"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":"profileId","in":"path","schemaId":"schema_451","description":"id of the profile","required":true}],"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1searches~1link/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_469"}},"schemaId":"schema_469","pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1searches~1link/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/compliance/kyc-protect/profiles/{profileId}/searches/link","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"schemaId":"schema_451"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_469"}},"responseCodes":["200","400","401","403","409"],"pointer":"/compliance/kyc-protect/profiles/{profileId}/searches/link","href":"aml-screening-profile-management/kycprotectaddsasearchtothegivenprofile","openApiOperationId":"kycProtectAddsASearchToTheGivenProfile","summary":"Add AML Searches To The Given Profile"},"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_469","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_469"}},"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_470"}},"schemaId":"schema_470"},{"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":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}],"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1searches~1link/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_470","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_470"}}},{"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":"409","schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/aml-screening-profile-management/kycprotectaddsasearchtothegivenprofile"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/profiles/{profileId}/searches/link"},{"label":"Alert Metrics","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-profile-management/complianceprotectgetkycprofilealertsmetrics","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-profile-management/complianceprotectgetkycprofilealertsmetrics","metadata":{"seo":{"title":"Alert Metrics","description":"Returns a list of KYC and AML alert metrics on profiles."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"complianceProtectGetKycProfileAlertsMetrics","name":"Alert Metrics","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1alerts~1metrics/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Alert Metrics","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a list of KYC and AML alert metrics on profiles."},{"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_398","description":"Starting page number."},{"name":"pageSize","in":"query","schemaId":"schema_388","description":"Specifies the number of items to be displayed per page. Allowed values are between 1 and 100."},{"name":"searchTerm","in":"query","schemaId":"schema_387","description":"A search term to search by. The search term will be matched against profile names, and internal ids"},{"name":"sortOrder","in":"query","schemaId":"schema_387","description":"The order in which the items should be sorted. Available values: asc, desc"},{"name":"sortBy","in":"query","schemaId":"schema_387","description":"The field by which the items should be sorted. Available values: alertLastModifiedDate, addedToMonitoringDate, latestAlertDate"},{"name":"assignedToId","in":"query","schemaId":"schema_471","description":"The profile assignee to filter by."}],"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1alerts~1metrics/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/compliance/kyc-protect/profiles/alerts/metrics","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_398"},{"name":"pageSize","in":"query","schemaId":"schema_388"},{"name":"searchTerm","in":"query","required":false,"schemaId":"schema_387"},{"name":"sortOrder","in":"query","schemaId":"schema_387"},{"name":"sortBy","in":"query","schemaId":"schema_387"},{"name":"assignedToId","in":"query","schemaId":"schema_471"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409"],"pointer":"/compliance/kyc-protect/profiles/alerts/metrics","href":"aml-screening-profile-management/complianceprotectgetkycprofilealertsmetrics","openApiOperationId":"complianceProtectGetKycProfileAlertsMetrics","summary":"Alert Metrics"},"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_472"}},"schemaId":"schema_472"},{"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","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}],"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1alerts~1metrics/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_472","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_472"}}},{"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":"409","schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/aml-screening-profile-management/complianceprotectgetkycprofilealertsmetrics"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/profiles/alerts/metrics"}],"content":{"contentType":"group","meta":{"name":"AML Screening - Profile Management"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"AML Screening - Profile Management","showPageActions":true},{"nodeType":"markdoc","content":"Endpoints to manage AML screening profiles, including creating, updating, and retrieving screening results."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/compliance/kyc-protect/profiles/{profileId}/amlAlerts","summary":"Return All Hits Linked To The Profile","prefix":{"name":"get","color":"get"},"badges":[],"link":"/aml-screening-profile-management/kycprotectgetamlalertsbyprofileid","deprecated":false},{"title":"/compliance/kyc-protect/profiles/{profileId}/hits","summary":"Return All Hits Of Searches Linked To A Profile","prefix":{"name":"get","color":"get"},"badges":[],"link":"/aml-screening-profile-management/getkychitsofthesearcheslinkedtoprofile","deprecated":false},{"title":"/compliance/kyc-protect/profiles/{profileId}/schedules","summary":"Return All Schedules By ProfileId And Modified Date","prefix":{"name":"get","color":"get"},"badges":[],"link":"/aml-screening-profile-management/kycprotectgetprofileschedules","deprecated":false},{"title":"/compliance/kyc-protect/profiles/{profileId}/schedules/{scheduleId}","summary":"Return Schedule By ProfileId And ScheduleId","prefix":{"name":"get","color":"get"},"badges":[],"link":"/aml-screening-profile-management/kycprotectgetprofileschedulesbyscheduleid","deprecated":false},{"title":"/compliance/kyc-protect/profiles/{profileId}/searches","summary":"Return List Of AML Searches On The Given Profile","prefix":{"name":"get","color":"get"},"badges":[],"link":"/aml-screening-profile-management/kycprotectgetslistofsearchesonthegivenprofile","deprecated":false},{"title":"/compliance/kyc-protect/profiles/{profileId}/searches","summary":"Delete AML searches linked to a profile","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/aml-screening-profile-management/deletekycprofilesearchesbyprofileid","deprecated":false},{"title":"/compliance/kyc-protect/profiles/{profileId}/searches/link","summary":"Add AML Searches To The Given Profile","prefix":{"name":"post","color":"post"},"badges":[],"link":"/aml-screening-profile-management/kycprotectaddsasearchtothegivenprofile","deprecated":false},{"title":"/compliance/kyc-protect/profiles/alerts/metrics","summary":"Alert Metrics","prefix":{"name":"get","color":"get"},"badges":[],"link":"/aml-screening-profile-management/complianceprotectgetkycprofilealertsmetrics","deprecated":false}]}]}]}]}},{"type":"group","label":"Async AML","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/async-aml","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/async-aml","items":[{"label":"Return All Async AML Jobs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/async-aml/compliancegetkycasyncamljobs","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/async-aml/compliancegetkycasyncamljobs","metadata":{"seo":{"title":"Return All Async AML Jobs","description":"Gets a list of async aml jobs for user."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"compliancegetkycasyncamljobs","name":"Return All Async AML Jobs","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1asyncAmlJobs/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return All Async AML Jobs","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets a list of async aml jobs for user."},{"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_398","description":"Starting page number."},{"name":"pageSize","in":"query","schemaId":"schema_388","description":"Specifies the number of items to be displayed per page. Allowed values are between 1 and 100."},{"name":"statuses","in":"query","schemaId":"schema_449","description":"The async job statuses. It can be the collection of created, processing, completed"},{"name":"targetType","in":"query","schemaId":"schema_473","description":"The async job's target type. It can be either Profile or KeyParty"}],"pointer":"/paths/~1compliance~1kyc-protect~1asyncAmlJobs/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/compliance/kyc-protect/asyncAmlJobs","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_398"},{"name":"pageSize","in":"query","schemaId":"schema_388"},{"name":"statuses","in":"query","schemaId":"schema_449"},{"name":"targetType","in":"query","schemaId":"schema_473"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409"],"pointer":"/compliance/kyc-protect/asyncAmlJobs","href":"async-aml/compliancegetkycasyncamljobs","openApiOperationId":"compliancegetkycasyncamljobs","summary":"Return All Async AML Jobs"},"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/GetKycProtectAsyncAmlJobResponse"}},"schemaId":"components/schemas/GetKycProtectAsyncAmlJobResponse"},{"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":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}],"pointer":"/paths/~1compliance~1kyc-protect~1asyncAmlJobs/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetKycProtectAsyncAmlJobResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetKycProtectAsyncAmlJobResponse"}}},{"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":"409","schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/async-aml/compliancegetkycasyncamljobs"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/asyncAmlJobs"},{"label":"Return Async AML Jobs By Id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/async-aml/compliancegetkycasyncamljobsjobid","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/async-aml/compliancegetkycasyncamljobsjobid","metadata":{"seo":{"title":"Return Async AML Jobs By Id","description":"Returns a list of async aml jobs for user."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"compliancegetkycasyncamljobsjobid","name":"Return Async AML Jobs By Id","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1asyncAmlJobs~1{jobId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return Async AML Jobs By Id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a list of async aml jobs for user."},{"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":"jobId","in":"path","schemaId":"schema_451","description":"id of the async aml job","required":true}],"pointer":"/paths/~1compliance~1kyc-protect~1asyncAmlJobs~1{jobId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_398","description":"Starting page number."},{"name":"pageSize","in":"query","schemaId":"schema_388","description":"Specifies the number of items to be displayed per page. Allowed values are between 1 and 100."}],"pointer":"/paths/~1compliance~1kyc-protect~1asyncAmlJobs~1{jobId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/compliance/kyc-protect/asyncAmlJobs/{jobId}","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"jobId","in":"path","required":true,"schemaId":"schema_451"}],"query":[{"name":"page","in":"query","schemaId":"schema_398"},{"name":"pageSize","in":"query","schemaId":"schema_388"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409"],"pointer":"/compliance/kyc-protect/asyncAmlJobs/{jobId}","href":"async-aml/compliancegetkycasyncamljobsjobid","openApiOperationId":"compliancegetkycasyncamljobsjobid","summary":"Return Async AML Jobs 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","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetKycProtectAsyncAmlJobItemResponse"}},"schemaId":"components/schemas/GetKycProtectAsyncAmlJobItemResponse"},{"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":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}],"pointer":"/paths/~1compliance~1kyc-protect~1asyncAmlJobs~1{jobId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetKycProtectAsyncAmlJobItemResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetKycProtectAsyncAmlJobItemResponse"}}},{"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":"409","schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/async-aml/compliancegetkycasyncamljobsjobid"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/asyncAmlJobs/{jobId}"},{"label":"Return Async Job Criteria By Id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/async-aml/compliancegetkycasyncamljobsjobidcriteria","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/async-aml/compliancegetkycasyncamljobsjobidcriteria","metadata":{"seo":{"title":"Return Async Job Criteria By Id","description":"Gets a list of job criteria by async job id for user."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"compliancegetkycasyncamljobsjobidcriteria","name":"Return Async Job Criteria By Id","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1asyncAmlJobs~1{jobId}~1criteria/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return Async Job Criteria By Id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets a list of job criteria by async job id for user."},{"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":"jobId","in":"path","schemaId":"schema_451","description":"id of the async aml job","required":true}],"pointer":"/paths/~1compliance~1kyc-protect~1asyncAmlJobs~1{jobId}~1criteria/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_398","description":"Starting page number."},{"name":"pageSize","in":"query","schemaId":"schema_388","description":"Specifies the number of items to be displayed per page. Allowed values are between 1 and 100."},{"name":"statuses","in":"query","schemaId":"schema_449","description":"The async job criteria statuses. It can be the collection of submitted, processing, completed, failed."}],"pointer":"/paths/~1compliance~1kyc-protect~1asyncAmlJobs~1{jobId}~1criteria/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/compliance/kyc-protect/asyncAmlJobs/{jobId}/criteria","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"jobId","in":"path","required":true,"schemaId":"schema_451"}],"query":[{"name":"page","in":"query","schemaId":"schema_398"},{"name":"pageSize","in":"query","schemaId":"schema_388"},{"name":"statuses","in":"query","schemaId":"schema_449"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409"],"pointer":"/compliance/kyc-protect/asyncAmlJobs/{jobId}/criteria","href":"async-aml/compliancegetkycasyncamljobsjobidcriteria","openApiOperationId":"compliancegetkycasyncamljobsjobidcriteria","summary":"Return Async Job Criteria 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","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetKycProtectAsyncAmlJobCriteriaResponse"}},"schemaId":"components/schemas/GetKycProtectAsyncAmlJobCriteriaResponse"},{"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":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}],"pointer":"/paths/~1compliance~1kyc-protect~1asyncAmlJobs~1{jobId}~1criteria/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetKycProtectAsyncAmlJobCriteriaResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetKycProtectAsyncAmlJobCriteriaResponse"}}},{"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":"409","schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/async-aml/compliancegetkycasyncamljobsjobidcriteria"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/asyncAmlJobs/{jobId}/criteria"}],"content":{"contentType":"group","meta":{"name":"Async AML"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Async AML","showPageActions":true},{"nodeType":"markdoc","content":"Endpoints to return asynchronous AML jobs, such as bulk screenings or monitoring tasks."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/compliance/kyc-protect/asyncAmlJobs","summary":"Return All Async AML Jobs","prefix":{"name":"get","color":"get"},"badges":[],"link":"/async-aml/compliancegetkycasyncamljobs","deprecated":false},{"title":"/compliance/kyc-protect/asyncAmlJobs/{jobId}","summary":"Return Async AML Jobs By Id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/async-aml/compliancegetkycasyncamljobsjobid","deprecated":false},{"title":"/compliance/kyc-protect/asyncAmlJobs/{jobId}/criteria","summary":"Return Async Job Criteria By Id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/async-aml/compliancegetkycasyncamljobsjobidcriteria","deprecated":false}]}]}]}]}},{"type":"group","label":"Audit","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/audit","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/audit","items":[{"label":"Return Audit Trail","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/audit/compliancegetkycaudits","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/audit/compliancegetkycaudits","metadata":{"seo":{"title":"Return Audit Trail","description":"Returns a list of audits which can be filtered by various categories."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"complianceGetKycAudits","name":"Return Audit Trail","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1audits/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return Audit Trail","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a list of audits which can be filtered by various categories."},{"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":"profileIds","in":"query","schemaId":"schema_449","description":"Select the profileId's for the filter."},{"name":"categories","in":"query","schemaId":"schema_474","description":"Available categories for the filter."},{"name":"subcategories","in":"query","schemaId":"schema_475","description":"Available subcategories for the filter."},{"name":"actions","in":"query","schemaId":"schema_476","description":"Available actions for the filter."},{"name":"userIds","in":"query","schemaId":"schema_477","description":"User Ids for the filter."},{"name":"startDate","in":"query","schemaId":"schema_478","description":"Start date for the filter."},{"name":"endDate","in":"query","schemaId":"schema_478","description":"End date for the filter."},{"name":"page","in":"query","schemaId":"schema_398","description":"Starting page number."},{"name":"pageSize","in":"query","schemaId":"schema_388","description":"Specifies the number of items to be displayed per page. Allowed values are between 1 and 100."}],"pointer":"/paths/~1compliance~1kyc-protect~1audits/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/compliance/kyc-protect/audits","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[],"query":[{"name":"profileIds","in":"query","schemaId":"schema_449"},{"name":"categories","in":"query","schemaId":"schema_474"},{"name":"subcategories","in":"query","schemaId":"schema_475"},{"name":"actions","in":"query","schemaId":"schema_476"},{"name":"userIds","in":"query","schemaId":"schema_477"},{"name":"startDate","in":"query","schemaId":"schema_478"},{"name":"endDate","in":"query","schemaId":"schema_478"},{"name":"page","in":"query","schemaId":"schema_398"},{"name":"pageSize","in":"query","schemaId":"schema_388"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/compliance/kyc-protect/audits","href":"audit/compliancegetkycaudits","openApiOperationId":"complianceGetKycAudits","summary":"Return Audit Trail"},"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/GetAuditsResponse"}},"schemaId":"components/schemas/GetAuditsResponse"},{"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/~1compliance~1kyc-protect~1audits/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetAuditsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetAuditsResponse"}}},{"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":"/audit/compliancegetkycaudits"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/audits"}],"content":{"contentType":"group","meta":{"name":"Audit"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Audit","showPageActions":true},{"nodeType":"markdoc","content":"Endpoints to retrieve audit logs and track activity related to profiles, searches, and monitoring actions."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/compliance/kyc-protect/audits","summary":"Return Audit Trail","prefix":{"name":"get","color":"get"},"badges":[],"link":"/audit/compliancegetkycaudits","deprecated":false}]}]}]}]}},{"type":"group","label":"Batch Uploads","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/batch-uploads","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/batch-uploads","items":[{"label":"Request Batch Upload","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/batch-uploads/compliancepostkycbatchuploads","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/batch-uploads/compliancepostkycbatchuploads","metadata":{"seo":{"title":"Request Batch Upload","description":"Submits the batch file process request. Returns the details of the accepted request."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"compliancePostKycBatchUploads","name":"Request Batch Upload","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1batchUploads/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Request Batch Upload","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Submits the batch file process request. Returns the details of the accepted request."},{"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":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/PostKycProtectBatchUploadsRequest"}},"schemaId":"components/schemas/PostKycProtectBatchUploadsRequest","pointer":"/paths/~1compliance~1kyc-protect~1batchUploads/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/compliance/kyc-protect/batchUploads","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":{"multipart/form-data":{"schemaId":"components/schemas/PostKycProtectBatchUploadsRequest"}},"responseCodes":["202","400","401","403","409","502"],"pointer":"/compliance/kyc-protect/batchUploads","href":"batch-uploads/compliancepostkycbatchuploads","openApiOperationId":"compliancePostKycBatchUploads","summary":"Request Batch Upload"},"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/PostKycProtectBatchUploadsRequest","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/PostKycProtectBatchUploadsRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetKycProtectBatchUploadsByUploadIdItemResponse"}},"schemaId":"components/schemas/GetKycProtectBatchUploadsByUploadIdItemResponse"},{"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":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"},{"code":"502","description":"Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}],"pointer":"/paths/~1compliance~1kyc-protect~1batchUploads/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"components/schemas/GetKycProtectBatchUploadsByUploadIdItemResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetKycProtectBatchUploadsByUploadIdItemResponse"}}},{"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":"409","schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}}},{"code":"502","schemaId":"components/schemas/ConnectErrorResponsesBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/batch-uploads/compliancepostkycbatchuploads"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/batchUploads"},{"label":"Return A List Of Requested Uploads","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/batch-uploads/compliancegetkycbatchuploads","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/batch-uploads/compliancegetkycbatchuploads","metadata":{"seo":{"title":"Return A List Of Requested Uploads","description":"Returns a list of uploads that have been requested."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"complianceGetKycBatchUploads","name":"Return A List Of Requested Uploads","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1batchUploads/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return A List Of Requested Uploads","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a list of uploads that have been requested."},{"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_398","description":"Starting page number."},{"name":"pageSize","in":"query","schemaId":"schema_388","description":"Specifies the number of items to be displayed per page. Allowed values are between 1 and 100."},{"name":"statuses","in":"query","schemaId":"schema_449","description":"The statuses list to filter by. It can be the collection of submitted, validating, rejected, validated, insufficientCredits, queued, inProgress, processed, completed, partiallyCompleted, failed."},{"name":"uploadedById","in":"query","schemaId":"schema_471","description":"The id of the uploaded user to filter by."}],"pointer":"/paths/~1compliance~1kyc-protect~1batchUploads/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/compliance/kyc-protect/batchUploads","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_398"},{"name":"pageSize","in":"query","schemaId":"schema_388"},{"name":"statuses","in":"query","schemaId":"schema_449"},{"name":"uploadedById","in":"query","schemaId":"schema_471"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","409","502"],"pointer":"/compliance/kyc-protect/batchUploads","href":"batch-uploads/compliancegetkycbatchuploads","openApiOperationId":"complianceGetKycBatchUploads","summary":"Return A List Of Requested Uploads"},"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/GetKycProtectBatchUploadsByUploadsResponse"}},"schemaId":"components/schemas/GetKycProtectBatchUploadsByUploadsResponse"},{"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":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"},{"code":"502","description":"Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}],"pointer":"/paths/~1compliance~1kyc-protect~1batchUploads/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetKycProtectBatchUploadsByUploadsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetKycProtectBatchUploadsByUploadsResponse"}}},{"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":"409","schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}}},{"code":"502","schemaId":"components/schemas/ConnectErrorResponsesBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/batch-uploads/compliancegetkycbatchuploads"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/batchUploads"},{"label":"Return Batch Upload File Details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/batch-uploads/compliancegetkycbatchuploadbyuploadid","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/batch-uploads/compliancegetkycbatchuploadbyuploadid","metadata":{"seo":{"title":"Return Batch Upload File Details","description":"Returns a batch Upload response as specified by the provided id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"complianceGetKycBatchUploadByUploadId","name":"Return Batch Upload File Details","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1batchUploads~1{uploadId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return Batch Upload File Details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a batch Upload response as specified by 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":"uploadId","in":"path","schemaId":"schema_471","description":"id of the upload.","required":true}],"pointer":"/paths/~1compliance~1kyc-protect~1batchUploads~1{uploadId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/compliance/kyc-protect/batchUploads/{uploadId}","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"uploadId","in":"path","required":true,"schemaId":"schema_471"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","409","502"],"pointer":"/compliance/kyc-protect/batchUploads/{uploadId}","href":"batch-uploads/compliancegetkycbatchuploadbyuploadid","openApiOperationId":"complianceGetKycBatchUploadByUploadId","summary":"Return Batch Upload File Details"},"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/GetKycProtectBatchUploadsByUploadIdItemResponse"}},"schemaId":"components/schemas/GetKycProtectBatchUploadsByUploadIdItemResponse"},{"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":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"},{"code":"502","description":"Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}],"pointer":"/paths/~1compliance~1kyc-protect~1batchUploads~1{uploadId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetKycProtectBatchUploadsByUploadIdItemResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetKycProtectBatchUploadsByUploadIdItemResponse"}}},{"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":"409","schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}}},{"code":"502","schemaId":"components/schemas/ConnectErrorResponsesBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/batch-uploads/compliancegetkycbatchuploadbyuploadid"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/batchUploads/{uploadId}"},{"label":"Download Batch Upload Error File","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/batch-uploads/compliancegetkycbatchuploadsdownloaderrorsbyuploadid","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/batch-uploads/compliancegetkycbatchuploadsdownloaderrorsbyuploadid","metadata":{"seo":{"title":"Download Batch Upload Error File","description":"Returns a link to download the error file if it has does fail during the upload this is acquired using the upload Id.."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"complianceGetKycBatchUploadsDownloadErrorsByUploadId","name":"Download Batch Upload Error File","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1batchUploads~1{uploadId}~1errors~1download/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download Batch Upload Error File","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a link to download the error file if it has does fail during the upload this is acquired using the upload 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":"uploadId","in":"path","schemaId":"schema_451","description":"id of the upload","required":true}],"pointer":"/paths/~1compliance~1kyc-protect~1batchUploads~1{uploadId}~1errors~1download/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/compliance/kyc-protect/batchUploads/{uploadId}/errors/download","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"uploadId","in":"path","required":true,"schemaId":"schema_451"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","502"],"pointer":"/compliance/kyc-protect/batchUploads/{uploadId}/errors/download","href":"batch-uploads/compliancegetkycbatchuploadsdownloaderrorsbyuploadid","openApiOperationId":"complianceGetKycBatchUploadsDownloadErrorsByUploadId","summary":"Download Batch Upload Error File"},"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":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetBatchUploadsDownloadErrorsByUploadIdResponse"}},"schemaId":"components/schemas/GetBatchUploadsDownloadErrorsByUploadIdResponse"},{"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":"502","description":"Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}],"pointer":"/paths/~1compliance~1kyc-protect~1batchUploads~1{uploadId}~1errors~1download/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetBatchUploadsDownloadErrorsByUploadIdResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetBatchUploadsDownloadErrorsByUploadIdResponse"}}},{"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":"502","schemaId":"components/schemas/ConnectErrorResponsesBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/batch-uploads/compliancegetkycbatchuploadsdownloaderrorsbyuploadid"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/batchUploads/{uploadId}/errors/download"},{"label":"Retry Previous Upload","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/batch-uploads/compliancegetkycbatchuploadsretrybyuploadid","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/batch-uploads/compliancegetkycbatchuploadsretrybyuploadid","metadata":{"seo":{"title":"Retry Previous Upload","description":"Re-uploads the file if it was previously failed due to 'insufficientCredits' status."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"complianceGetKycBatchUploadsRetryByUploadId","name":"Retry Previous Upload","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1batchUploads~1{uploadId}~1retry/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retry Previous Upload","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Re-uploads the file if it was previously failed due to 'insufficientCredits' status."},{"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":"uploadId","in":"path","schemaId":"schema_451","description":"id of the upload","required":true}],"pointer":"/paths/~1compliance~1kyc-protect~1batchUploads~1{uploadId}~1retry/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/compliance/kyc-protect/batchUploads/{uploadId}/retry","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"uploadId","in":"path","required":true,"schemaId":"schema_451"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["202","400","401","403","404","409","502"],"pointer":"/compliance/kyc-protect/batchUploads/{uploadId}/retry","href":"batch-uploads/compliancegetkycbatchuploadsretrybyuploadid","openApiOperationId":"complianceGetKycBatchUploadsRetryByUploadId","summary":"Retry Previous Upload"},"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":"202","description":"Accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PutBatchUploadsRetryByIdResponse"}},"schemaId":"components/schemas/PutBatchUploadsRetryByIdResponse"},{"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":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"},{"code":"502","description":"Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}],"pointer":"/paths/~1compliance~1kyc-protect~1batchUploads~1{uploadId}~1retry/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"components/schemas/PutBatchUploadsRetryByIdResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PutBatchUploadsRetryByIdResponse"}}},{"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":"409","schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}}},{"code":"502","schemaId":"components/schemas/ConnectErrorResponsesBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/batch-uploads/compliancegetkycbatchuploadsretrybyuploadid"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/batchUploads/{uploadId}/retry"},{"label":"Return Template For Batch Upload","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/batch-uploads/compliancegetkycbatchuploadstemplate","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/batch-uploads/compliancegetkycbatchuploadstemplate","metadata":{"seo":{"title":"Return Template For Batch Upload","description":"This endpoint the HTTP Request is planned to be altered in the next release"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"complianceGetKycBatchUploadsTemplate","name":"Return Template For Batch Upload","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1batchUploads~1template/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return Template For Batch Upload","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"h3","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"This endpoint the HTTP Request is planned to be altered in the next release"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","attributes":{"content":" Returns the template to complete a batch upload."},"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":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/compliance/kyc-protect/batchUploads/template","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","502"],"pointer":"/compliance/kyc-protect/batchUploads/template","href":"batch-uploads/compliancegetkycbatchuploadstemplate","openApiOperationId":"complianceGetKycBatchUploadsTemplate","summary":"Return Template For Batch Upload"},"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/GetBatchUploadsTemplateResponse"}},"schemaId":"components/schemas/GetBatchUploadsTemplateResponse"},{"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":"502","description":"Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}],"pointer":"/paths/~1compliance~1kyc-protect~1batchUploads~1template/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetBatchUploadsTemplateResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetBatchUploadsTemplateResponse"}}},{"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":"502","schemaId":"components/schemas/ConnectErrorResponsesBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/batch-uploads/compliancegetkycbatchuploadstemplate"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/batchUploads/template"}],"content":{"contentType":"group","meta":{"name":"Batch Uploads"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Batch Uploads","showPageActions":true},{"nodeType":"markdoc","content":"Endpoints to upload and process batch files for profiles or searches, including retrying failed uploads and downloading error reports."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/compliance/kyc-protect/batchUploads","summary":"Request Batch Upload","prefix":{"name":"post","color":"post"},"badges":[],"link":"/batch-uploads/compliancepostkycbatchuploads","deprecated":false},{"title":"/compliance/kyc-protect/batchUploads","summary":"Return A List Of Requested Uploads","prefix":{"name":"get","color":"get"},"badges":[],"link":"/batch-uploads/compliancegetkycbatchuploads","deprecated":false},{"title":"/compliance/kyc-protect/batchUploads/{uploadId}","summary":"Return Batch Upload File Details","prefix":{"name":"get","color":"get"},"badges":[],"link":"/batch-uploads/compliancegetkycbatchuploadbyuploadid","deprecated":false},{"title":"/compliance/kyc-protect/batchUploads/{uploadId}/errors/download","summary":"Download Batch Upload Error File","prefix":{"name":"get","color":"get"},"badges":[],"link":"/batch-uploads/compliancegetkycbatchuploadsdownloaderrorsbyuploadid","deprecated":false},{"title":"/compliance/kyc-protect/batchUploads/{uploadId}/retry","summary":"Retry Previous Upload","prefix":{"name":"put","color":"put"},"badges":[],"link":"/batch-uploads/compliancegetkycbatchuploadsretrybyuploadid","deprecated":false},{"title":"/compliance/kyc-protect/batchUploads/template","summary":"Return Template For Batch Upload","prefix":{"name":"get","color":"get"},"badges":[],"link":"/batch-uploads/compliancegetkycbatchuploadstemplate","deprecated":false}]}]}]}]}},{"type":"group","label":"Compliance Alerts","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/compliance-alerts","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/compliance-alerts","items":[{"label":"Return Compliance Alerts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/compliance-alerts/compliancegetkycalerts","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/compliance-alerts/compliancegetkycalerts","metadata":{"seo":{"title":"Return Compliance Alerts","description":"Returns compliance alerts for a company by automatically fetching the company report using the provided connectId or Safe Number, extracting required data (directors, UBOs, etc.), and processing it through the compliance alerts API. This eliminates the need for manual report retrieval and data transformation."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"complianceGetKYCAlerts","name":"Return Compliance Alerts","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1complianceAlerts~1{connectId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return Compliance Alerts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns compliance alerts for a company by automatically fetching the company report using the provided connectId or Safe Number, extracting required data (directors, UBOs, etc.), and processing it through the compliance alerts API. This eliminates the need for manual report retrieval and data transformation.\n"},{"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_387","description":"The connectId (optionally Safe Number where available) of the Company required to order their Credit Report.","required":true,"example":"GB-0-03836192"}],"pointer":"/paths/~1compliance~1kyc-protect~1complianceAlerts~1{connectId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/compliance/kyc-protect/complianceAlerts/{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_387"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["202","400","401","403","409","502"],"pointer":"/compliance/kyc-protect/complianceAlerts/{connectId}","href":"compliance-alerts/compliancegetkycalerts","openApiOperationId":"complianceGetKYCAlerts","summary":"Return Compliance Alerts"},"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":"202","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetKycProtectAlertResponse"}},"schemaId":"components/schemas/GetKycProtectAlertResponse"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}},"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}},"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"},{"code":"502","description":"Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}],"pointer":"/paths/~1compliance~1kyc-protect~1complianceAlerts~1{connectId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"components/schemas/GetKycProtectAlertResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetKycProtectAlertResponse"}}},{"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":"409","schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}}},{"code":"502","schemaId":"components/schemas/ConnectErrorResponsesBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/compliance-alerts/compliancegetkycalerts"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/complianceAlerts/{connectId}"}],"content":{"contentType":"group","meta":{"name":"Compliance Alerts"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Compliance Alerts","showPageActions":true},{"nodeType":"markdoc","content":"Endpoints to manage and retrieve compliance alerts related to companies via a connectId."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/compliance/kyc-protect/complianceAlerts/{connectId}","summary":"Return Compliance Alerts","prefix":{"name":"get","color":"get"},"badges":[],"link":"/compliance-alerts/compliancegetkycalerts","deprecated":false}]}]}]}]}},{"type":"group","label":"Global Monitoring","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/global-monitoring","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/global-monitoring","items":[{"label":"Delete Profiles From Monitoring","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/global-monitoring/compliancedeletekycmonitoringprofiles","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/global-monitoring/compliancedeletekycmonitoringprofiles","metadata":{"seo":{"title":"Delete Profiles From Monitoring","description":"Removes list of profiles from kyc monitoring"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"complianceDeleteKycMonitoringProfiles","name":"Delete Profiles From Monitoring","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1kycMonitoring~1profiles/delete","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Profiles From Monitoring","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Removes list of profiles from kyc monitoring"},{"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/DeleteKYCMonitoringProfilesResquest"}},"schemaId":"components/schemas/DeleteKYCMonitoringProfilesResquest","pointer":"/paths/~1compliance~1kyc-protect~1kycMonitoring~1profiles/delete/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/compliance/kyc-protect/kycMonitoring/profiles","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/DeleteKYCMonitoringProfilesResquest"}},"responseCodes":["200","400","401","403","404","409","502"],"pointer":"/compliance/kyc-protect/kycMonitoring/profiles","href":"global-monitoring/compliancedeletekycmonitoringprofiles","openApiOperationId":"complianceDeleteKycMonitoringProfiles","summary":"Delete Profiles From Monitoring"},"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/DeleteKYCMonitoringProfilesResquest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DeleteKYCMonitoringProfilesResquest"}},"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/DeleteKYCMonitoringProfilesResponse"}},"schemaId":"components/schemas/DeleteKYCMonitoringProfilesResponse"},{"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","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"},{"code":"502","description":"Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}],"pointer":"/paths/~1compliance~1kyc-protect~1kycMonitoring~1profiles/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/DeleteKYCMonitoringProfilesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DeleteKYCMonitoringProfilesResponse"}}},{"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":"409","schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}}},{"code":"502","schemaId":"components/schemas/ConnectErrorResponsesBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/global-monitoring/compliancedeletekycmonitoringprofiles"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/kycMonitoring/profiles"},{"label":"Return List Of Alerts By Profile","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/global-monitoring/compliancegetkycmonitoringprofilealertsbyprofileid","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/global-monitoring/compliancegetkycmonitoringprofilealertsbyprofileid","metadata":{"seo":{"title":"Return List Of Alerts By Profile","description":"Gets a list of kyc alerts by profile."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"compliancegetkycmonitoringprofilealertsbyprofileid","name":"Return List Of Alerts By Profile","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1kycMonitoring~1profiles~1{profileId}~1alerts/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return List Of Alerts By Profile","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets a list of kyc alerts by profile."},{"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":"profileId","in":"path","schemaId":"schema_451","description":"id of the profile","required":true}],"pointer":"/paths/~1compliance~1kyc-protect~1kycMonitoring~1profiles~1{profileId}~1alerts/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_398","description":"Starting page number."},{"name":"pageSize","in":"query","schemaId":"schema_388","description":"Specifies the number of items to be displayed per page. Allowed values are between 1 and 100."},{"name":"statuses","in":"query","schemaId":"schema_449","description":"Statuses of kyc alert to filter. Allowed values are Open, ClosedProcessed and ClosedUnprocessed"}],"pointer":"/paths/~1compliance~1kyc-protect~1kycMonitoring~1profiles~1{profileId}~1alerts/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/compliance/kyc-protect/kycMonitoring/profiles/{profileId}/alerts","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"schemaId":"schema_451"}],"query":[{"name":"page","in":"query","schemaId":"schema_398"},{"name":"pageSize","in":"query","schemaId":"schema_388"},{"name":"statuses","in":"query","schemaId":"schema_449"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409"],"pointer":"/compliance/kyc-protect/kycMonitoring/profiles/{profileId}/alerts","href":"global-monitoring/compliancegetkycmonitoringprofilealertsbyprofileid","openApiOperationId":"compliancegetkycmonitoringprofilealertsbyprofileid","summary":"Return List Of Alerts By Profile"},"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":"Accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_479"}},"schemaId":"schema_479"},{"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":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}],"pointer":"/paths/~1compliance~1kyc-protect~1kycMonitoring~1profiles~1{profileId}~1alerts/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_479","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_479"}}},{"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":"409","schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/global-monitoring/compliancegetkycmonitoringprofilealertsbyprofileid"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/kycMonitoring/profiles/{profileId}/alerts"},{"label":"Return Alert By Alert Id And ProfileId","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/global-monitoring/compliancegetkycmonitoringindividualprofilealertsbyalertid","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/global-monitoring/compliancegetkycmonitoringindividualprofilealertsbyalertid","metadata":{"seo":{"title":"Return Alert By Alert Id And ProfileId","description":"Gets a kyc alert associated with a given profile."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"compliancegetkycmonitoringindividualprofilealertsbyalertid","name":"Return Alert By Alert Id And ProfileId","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1kycMonitoring~1profiles~1{profileId}~1alerts~1{alertId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return Alert By Alert Id And ProfileId","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets a kyc alert associated with a given profile."},{"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":"profileId","in":"path","schemaId":"schema_451","description":"id of the profile","required":true},{"name":"alertId","in":"path","schemaId":"schema_451","description":"id of the kyc alert","required":true}],"pointer":"/paths/~1compliance~1kyc-protect~1kycMonitoring~1profiles~1{profileId}~1alerts~1{alertId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/compliance/kyc-protect/kycMonitoring/profiles/{profileId}/alerts/{alertId}","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"schemaId":"schema_451"},{"name":"alertId","in":"path","required":true,"schemaId":"schema_451"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409"],"pointer":"/compliance/kyc-protect/kycMonitoring/profiles/{profileId}/alerts/{alertId}","href":"global-monitoring/compliancegetkycmonitoringindividualprofilealertsbyalertid","openApiOperationId":"compliancegetkycmonitoringindividualprofilealertsbyalertid","summary":"Return Alert By Alert Id And ProfileId"},"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":"Accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KycMonitoringKycAlertResponse"}},"schemaId":"components/schemas/KycMonitoringKycAlertResponse"},{"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":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}],"pointer":"/paths/~1compliance~1kyc-protect~1kycMonitoring~1profiles~1{profileId}~1alerts~1{alertId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/KycMonitoringKycAlertResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KycMonitoringKycAlertResponse"}}},{"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":"409","schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/global-monitoring/compliancegetkycmonitoringindividualprofilealertsbyalertid"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/kycMonitoring/profiles/{profileId}/alerts/{alertId}"},{"label":"Update Status of Alert By Profile Id And Alert Id","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/global-monitoring/complianceputkycmonitoringindividualprofilealertsbyalertid","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/global-monitoring/complianceputkycmonitoringindividualprofilealertsbyalertid","metadata":{"seo":{"title":"Update Status of Alert By Profile Id And Alert Id","description":"Updates a kyc alert associated with a given profile"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"complianceputkycmonitoringindividualprofilealertsbyalertid","name":"Update Status of Alert By Profile Id And Alert Id","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1kycMonitoring~1profiles~1{profileId}~1alerts~1{alertId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Status of Alert By Profile Id And Alert Id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates a kyc alert associated with a given profile"},{"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":"profileId","in":"path","schemaId":"schema_451","description":"id of the profile","required":true},{"name":"alertId","in":"path","schemaId":"schema_451","description":"id of the kyc alert","required":true}],"pointer":"/paths/~1compliance~1kyc-protect~1kycMonitoring~1profiles~1{profileId}~1alerts~1{alertId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateKycAlertContract"}},"schemaId":"components/schemas/UpdateKycAlertContract","pointer":"/paths/~1compliance~1kyc-protect~1kycMonitoring~1profiles~1{profileId}~1alerts~1{alertId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/compliance/kyc-protect/kycMonitoring/profiles/{profileId}/alerts/{alertId}","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"schemaId":"schema_451"},{"name":"alertId","in":"path","required":true,"schemaId":"schema_451"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateKycAlertContract"}},"responseCodes":["200","400","401","403","404","409"],"pointer":"/compliance/kyc-protect/kycMonitoring/profiles/{profileId}/alerts/{alertId}","href":"global-monitoring/complianceputkycmonitoringindividualprofilealertsbyalertid","openApiOperationId":"complianceputkycmonitoringindividualprofilealertsbyalertid","summary":"Update Status of Alert By Profile Id And Alert 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"}],"schemaId":"components/schemas/UpdateKycAlertContract","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateKycAlertContract"}},"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/KycMonitoringKycAlertResponse"}},"schemaId":"components/schemas/KycMonitoringKycAlertResponse"},{"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","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}],"pointer":"/paths/~1compliance~1kyc-protect~1kycMonitoring~1profiles~1{profileId}~1alerts~1{alertId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/KycMonitoringKycAlertResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KycMonitoringKycAlertResponse"}}},{"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":"409","schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/global-monitoring/complianceputkycmonitoringindividualprofilealertsbyalertid"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/kycMonitoring/profiles/{profileId}/alerts/{alertId}"},{"label":"Add Profiles To Monitoring","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/global-monitoring/compliancepostkycmonitoringprofilesbulk","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/global-monitoring/compliancepostkycmonitoringprofilesbulk","metadata":{"seo":{"title":"Add Profiles To Monitoring","description":"Adds a list of profile/s to monitoring."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"compliancePostKycMonitoringProfilesBulk","name":"Add Profiles To Monitoring","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1kycMonitoring~1profiles~1bulk/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add Profiles To Monitoring","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Adds a list of profile/s to monitoring."},{"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/PostKYCMonitoringProfilesBulkResquest"}},"schemaId":"components/schemas/PostKYCMonitoringProfilesBulkResquest","pointer":"/paths/~1compliance~1kyc-protect~1kycMonitoring~1profiles~1bulk/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/compliance/kyc-protect/kycMonitoring/profiles/bulk","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/PostKYCMonitoringProfilesBulkResquest"}},"responseCodes":["200","400","401","403","404","409","502"],"pointer":"/compliance/kyc-protect/kycMonitoring/profiles/bulk","href":"global-monitoring/compliancepostkycmonitoringprofilesbulk","openApiOperationId":"compliancePostKycMonitoringProfilesBulk","summary":"Add Profiles To Monitoring"},"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/PostKYCMonitoringProfilesBulkResquest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PostKYCMonitoringProfilesBulkResquest"}},"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/PostKYCMonitoringProfilesBulkResponse"}},"schemaId":"components/schemas/PostKYCMonitoringProfilesBulkResponse"},{"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","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"},{"code":"502","description":"Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}],"pointer":"/paths/~1compliance~1kyc-protect~1kycMonitoring~1profiles~1bulk/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PostKYCMonitoringProfilesBulkResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PostKYCMonitoringProfilesBulkResponse"}}},{"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":"409","schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}}},{"code":"502","schemaId":"components/schemas/ConnectErrorResponsesBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/global-monitoring/compliancepostkycmonitoringprofilesbulk"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/kycMonitoring/profiles/bulk"},{"label":"Return Available Country Codes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/global-monitoring/complianceprotectgetlookupmonitoringcountrycodes","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/global-monitoring/complianceprotectgetlookupmonitoringcountrycodes","metadata":{"seo":{"title":"Return Available Country Codes","description":"Gets the list of acceptable country codes for kyc monitoring."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"complianceProtectGetLookupMonitoringCountryCodes","name":"Return Available Country Codes","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1lookup~1kycMonitoring~1countryCodes/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return Available Country Codes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets the list of acceptable country codes for kyc monitoring."},{"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":"/compliance/kyc-protect/lookup/kycMonitoring/countryCodes","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","404"],"pointer":"/compliance/kyc-protect/lookup/kycMonitoring/countryCodes","href":"global-monitoring/complianceprotectgetlookupmonitoringcountrycodes","openApiOperationId":"complianceProtectGetLookupMonitoringCountryCodes","summary":"Return Available Country Codes"},"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_449"}},"schemaId":"schema_449"},{"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","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1compliance~1kyc-protect~1lookup~1kycMonitoring~1countryCodes/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_449","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_449"}}},{"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":"/global-monitoring/complianceprotectgetlookupmonitoringcountrycodes"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/lookup/kycMonitoring/countryCodes"}],"content":{"contentType":"group","meta":{"name":"Global Monitoring"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Global Monitoring","showPageActions":true},{"nodeType":"markdoc","content":"Endpoints to monitor changes to company information globally, including event rules and notifications."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/compliance/kyc-protect/kycMonitoring/profiles","summary":"Delete Profiles From Monitoring","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/global-monitoring/compliancedeletekycmonitoringprofiles","deprecated":false},{"title":"/compliance/kyc-protect/kycMonitoring/profiles/{profileId}/alerts","summary":"Return List Of Alerts By Profile","prefix":{"name":"get","color":"get"},"badges":[],"link":"/global-monitoring/compliancegetkycmonitoringprofilealertsbyprofileid","deprecated":false},{"title":"/compliance/kyc-protect/kycMonitoring/profiles/{profileId}/alerts/{alertId}","summary":"Return Alert By Alert Id And ProfileId","prefix":{"name":"get","color":"get"},"badges":[],"link":"/global-monitoring/compliancegetkycmonitoringindividualprofilealertsbyalertid","deprecated":false},{"title":"/compliance/kyc-protect/kycMonitoring/profiles/{profileId}/alerts/{alertId}","summary":"Update Status of Alert By Profile Id And Alert Id","prefix":{"name":"put","color":"put"},"badges":[],"link":"/global-monitoring/complianceputkycmonitoringindividualprofilealertsbyalertid","deprecated":false},{"title":"/compliance/kyc-protect/kycMonitoring/profiles/bulk","summary":"Add Profiles To Monitoring","prefix":{"name":"post","color":"post"},"badges":[],"link":"/global-monitoring/compliancepostkycmonitoringprofilesbulk","deprecated":false},{"title":"/compliance/kyc-protect/lookup/kycMonitoring/countryCodes","summary":"Return Available Country Codes","prefix":{"name":"get","color":"get"},"badges":[],"link":"/global-monitoring/complianceprotectgetlookupmonitoringcountrycodes","deprecated":false}]}]}]}]}},{"type":"group","label":"Profile Business / Individual Details","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-business-individual-details","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-business-individual-details","items":[{"label":"Return Profile Details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-business-individual-details/protectgetkycprofiledetails","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-business-individual-details/protectgetkycprofiledetails","metadata":{"seo":{"title":"Return Profile Details","description":"Fetches details of a profile by profile Id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"protectGetKycProfileDetails","name":"Return Profile Details","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1details/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return Profile Details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Fetches details of a profile by profile 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":"profileId","in":"path","schemaId":"schema_387","description":"Id of a profile.","required":true,"example":"9a7ae0c8-f473-4ab6-8dbb-03fc061630cc"}],"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1details/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/compliance/kyc-protect/profiles/{profileId}/details","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"example":"9a7ae0c8-f473-4ab6-8dbb-03fc061630cc","schemaId":"schema_387"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/compliance/kyc-protect/profiles/{profileId}/details","href":"profile-business-individual-details/protectgetkycprofiledetails","openApiOperationId":"protectGetKycProfileDetails","summary":"Return Profile Details"},"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/GetKYCProfileDetailsByProfileId"}},"schemaId":"components/schemas/GetKYCProfileDetailsByProfileId"},{"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","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1details/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetKYCProfileDetailsByProfileId","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetKYCProfileDetailsByProfileId"}}},{"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":"/profile-business-individual-details/protectgetkycprofiledetails"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/profiles/{profileId}/details"},{"label":"Update Profile Details","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-business-individual-details/protectputkycprofiledetails","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-business-individual-details/protectputkycprofiledetails","metadata":{"seo":{"title":"Update Profile Details","description":"Updates the details of profile by the profileId."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"protectPutKycProfileDetails","name":"Update Profile Details","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1details/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Profile Details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates the details of profile by the profileId."},{"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":"profileId","in":"path","schemaId":"schema_387","description":"Id of a profile.","required":true,"example":"9a7ae0c8-f473-4ab6-8dbb-03fc061630cc"}],"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1details/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PutKYCProfileDetailsByProfileIdRequest"}},"schemaId":"components/schemas/PutKYCProfileDetailsByProfileIdRequest","pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1details/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/compliance/kyc-protect/profiles/{profileId}/details","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"example":"9a7ae0c8-f473-4ab6-8dbb-03fc061630cc","schemaId":"schema_387"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PutKYCProfileDetailsByProfileIdRequest"}},"responseCodes":["200","400","401","403","404"],"pointer":"/compliance/kyc-protect/profiles/{profileId}/details","href":"profile-business-individual-details/protectputkycprofiledetails","openApiOperationId":"protectPutKycProfileDetails","summary":"Update Profile Details"},"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/PutKYCProfileDetailsByProfileIdRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PutKYCProfileDetailsByProfileIdRequest"}},"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/PutKYCProfileDetailsByProfileId"}},"schemaId":"components/schemas/PutKYCProfileDetailsByProfileId"},{"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","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1details/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PutKYCProfileDetailsByProfileId","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PutKYCProfileDetailsByProfileId"}}},{"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":"/profile-business-individual-details/protectputkycprofiledetails"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/profiles/{profileId}/details"},{"label":"Create An Address For A Profile","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-business-individual-details/kycprotectcreatesanaddressfortheuser","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-business-individual-details/kycprotectcreatesanaddressfortheuser","metadata":{"seo":{"title":"Create An Address For A Profile","description":"Creates an address for the given profileId. Returns the created address information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"kycProtectCreatesAnAddressForTheUser","name":"Create An Address For A Profile","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1details~1addresses/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create An Address For A Profile","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates an address for the given profileId. Returns the created address information."},{"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":"profileId","in":"path","schemaId":"schema_451","description":"id of the profile","required":true}],"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1details~1addresses/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_480"}},"schemaId":"schema_480","pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1details~1addresses/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/compliance/kyc-protect/profiles/{profileId}/details/addresses","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"schemaId":"schema_451"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_480"}},"responseCodes":["201","400","401","403","409"],"pointer":"/compliance/kyc-protect/profiles/{profileId}/details/addresses","href":"profile-business-individual-details/kycprotectcreatesanaddressfortheuser","openApiOperationId":"kycProtectCreatesAnAddressForTheUser","summary":"Create An Address For A Profile"},"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_480","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_480"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KycProtectProfileAddressResponse"}},"schemaId":"components/schemas/KycProtectProfileAddressResponse"},{"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":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}],"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1details~1addresses/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/KycProtectProfileAddressResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KycProtectProfileAddressResponse"}}},{"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":"409","schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/profile-business-individual-details/kycprotectcreatesanaddressfortheuser"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/profiles/{profileId}/details/addresses"},{"label":"Return Lists Of Addresses","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-business-individual-details/kycprotectgetslistofaddresses","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-business-individual-details/kycprotectgetslistofaddresses","metadata":{"seo":{"title":"Return Lists Of Addresses","description":"Returns list of addresses for the current logged in user based on profileId."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"kycProtectGetsListOfAddresses","name":"Return Lists Of Addresses","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1details~1addresses/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return Lists Of Addresses","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns list of addresses for the current logged in user based on profileId."},{"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":"profileId","in":"path","schemaId":"schema_451","description":"id of the profile","required":true}],"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1details~1addresses/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/compliance/kyc-protect/profiles/{profileId}/details/addresses","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"schemaId":"schema_451"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/compliance/kyc-protect/profiles/{profileId}/details/addresses","href":"profile-business-individual-details/kycprotectgetslistofaddresses","openApiOperationId":"kycProtectGetsListOfAddresses","summary":"Return Lists Of Addresses"},"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":"schema_481"}},"schemaId":"schema_481"},{"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/~1compliance~1kyc-protect~1profiles~1{profileId}~1details~1addresses/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_481","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_481"}}},{"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":"/profile-business-individual-details/kycprotectgetslistofaddresses"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/profiles/{profileId}/details/addresses"},{"label":"Return Profile Address Details By Profile And Address Id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-business-individual-details/protectgetkycprofileaddressdetailsbyprofileidandaddressid","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-business-individual-details/protectgetkycprofileaddressdetailsbyprofileidandaddressid","metadata":{"seo":{"title":"Return Profile Address Details By Profile And Address Id","description":"Returns the address by profile Id and address Id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"protectGETKYCProfileAddressDetailsByProfileIdAndAddressId","name":"Return Profile Address Details By Profile And Address Id","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1details~1addresses~1{addressId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return Profile Address Details By Profile And Address Id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the address by profile Id and address 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":"profileId","in":"path","schemaId":"schema_451","description":"Id of a profile.","required":true,"example":"9a7ae0c8-f473-4ab6-8dbb-03fc061630cc"},{"name":"addressId","in":"path","schemaId":"schema_451","description":"Id of a user address.","required":true,"example":"9a7ae0c8-f473-4ab6-8dbb-03fc061630cc"}],"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1details~1addresses~1{addressId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/compliance/kyc-protect/profiles/{profileId}/details/addresses/{addressId}","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"example":"9a7ae0c8-f473-4ab6-8dbb-03fc061630cc","schemaId":"schema_451"},{"name":"addressId","in":"path","required":true,"example":"9a7ae0c8-f473-4ab6-8dbb-03fc061630cc","schemaId":"schema_451"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/compliance/kyc-protect/profiles/{profileId}/details/addresses/{addressId}","href":"profile-business-individual-details/protectgetkycprofileaddressdetailsbyprofileidandaddressid","openApiOperationId":"protectGETKYCProfileAddressDetailsByProfileIdAndAddressId","summary":"Return Profile Address Details By Profile And Address 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/GetKYCAddressDetailsByTheGivenAddressIdForTheSuppliedProfileIdUser"}},"schemaId":"components/schemas/GetKYCAddressDetailsByTheGivenAddressIdForTheSuppliedProfileIdUser"},{"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","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1details~1addresses~1{addressId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetKYCAddressDetailsByTheGivenAddressIdForTheSuppliedProfileIdUser","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetKYCAddressDetailsByTheGivenAddressIdForTheSuppliedProfileIdUser"}}},{"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":"/profile-business-individual-details/protectgetkycprofileaddressdetailsbyprofileidandaddressid"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/profiles/{profileId}/details/addresses/{addressId}"},{"label":"Update Profile Address Details By Profile Id And Address Id","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-business-individual-details/protectputkycprofileaddressdetailsbyprofileidandaddressid","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-business-individual-details/protectputkycprofileaddressdetailsbyprofileidandaddressid","metadata":{"seo":{"title":"Update Profile Address Details By Profile Id And Address Id","description":"Update Profile Address Details By Profile Id And Address Id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"protectPUTKYCProfileAddressDetailsByProfileIdAndAddressId","name":"Update Profile Address Details By Profile Id And Address Id","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1details~1addresses~1{addressId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Profile Address Details By Profile Id And Address Id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update Profile Address Details By Profile Id And Address 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":"profileId","in":"path","schemaId":"schema_451","description":"Id of a profile.","required":true,"example":"9a7ae0c8-f473-4ab6-8dbb-03fc061630cc"},{"name":"addressId","in":"path","schemaId":"schema_451","description":"Id of a user address.","required":true,"example":"9a7ae0c8-f473-4ab6-8dbb-03fc061630cc"}],"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1details~1addresses~1{addressId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateKYCAddressDetailsByTheGivenAddressIdForTheSuppliedProfileIdUserRequest"}},"schemaId":"components/schemas/UpdateKYCAddressDetailsByTheGivenAddressIdForTheSuppliedProfileIdUserRequest","pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1details~1addresses~1{addressId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/compliance/kyc-protect/profiles/{profileId}/details/addresses/{addressId}","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"example":"9a7ae0c8-f473-4ab6-8dbb-03fc061630cc","schemaId":"schema_451"},{"name":"addressId","in":"path","required":true,"example":"9a7ae0c8-f473-4ab6-8dbb-03fc061630cc","schemaId":"schema_451"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateKYCAddressDetailsByTheGivenAddressIdForTheSuppliedProfileIdUserRequest"}},"responseCodes":["200","400","401","403","404","409"],"pointer":"/compliance/kyc-protect/profiles/{profileId}/details/addresses/{addressId}","href":"profile-business-individual-details/protectputkycprofileaddressdetailsbyprofileidandaddressid","openApiOperationId":"protectPUTKYCProfileAddressDetailsByProfileIdAndAddressId","summary":"Update Profile Address Details By Profile Id And Address 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"}],"schemaId":"components/schemas/UpdateKYCAddressDetailsByTheGivenAddressIdForTheSuppliedProfileIdUserRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateKYCAddressDetailsByTheGivenAddressIdForTheSuppliedProfileIdUserRequest"}},"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/KycProtectProfileAddressResponse"}},"schemaId":"components/schemas/KycProtectProfileAddressResponse"},{"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","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}],"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1details~1addresses~1{addressId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/KycProtectProfileAddressResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KycProtectProfileAddressResponse"}}},{"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":"409","schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/profile-business-individual-details/protectputkycprofileaddressdetailsbyprofileidandaddressid"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/profiles/{profileId}/details/addresses/{addressId}"},{"label":"Delete Profile Address Details By Profile Id And Address Id","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-business-individual-details/protectdeletekycprofileaddressdetailsbyprofileidandaddressid","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-business-individual-details/protectdeletekycprofileaddressdetailsbyprofileidandaddressid","metadata":{"seo":{"title":"Delete Profile Address Details By Profile Id And Address Id","description":"Deletes the address by profile Id and address id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"protectDeleteKYCProfileAddressDetailsByProfileIdAndAddressId","name":"Delete Profile Address Details By Profile Id And Address Id","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1details~1addresses~1{addressId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Profile Address Details By Profile Id And Address Id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes the address by profile Id and address 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":"profileId","in":"path","schemaId":"schema_451","description":"Id of a profile.","required":true,"example":"9a7ae0c8-f473-4ab6-8dbb-03fc061630cc"},{"name":"addressId","in":"path","schemaId":"schema_451","description":"Id of a addressId.","required":true,"example":"9a7ae0c8-f473-4ab6-8dbb-03fc061630cc"}],"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1details~1addresses~1{addressId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/compliance/kyc-protect/profiles/{profileId}/details/addresses/{addressId}","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"example":"9a7ae0c8-f473-4ab6-8dbb-03fc061630cc","schemaId":"schema_451"},{"name":"addressId","in":"path","required":true,"example":"9a7ae0c8-f473-4ab6-8dbb-03fc061630cc","schemaId":"schema_451"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","400","401","403","404"],"pointer":"/compliance/kyc-protect/profiles/{profileId}/details/addresses/{addressId}","href":"profile-business-individual-details/protectdeletekycprofileaddressdetailsbyprofileidandaddressid","openApiOperationId":"protectDeleteKYCProfileAddressDetailsByProfileIdAndAddressId","summary":"Delete Profile Address Details By Profile Id And Address 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":"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","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1details~1addresses~1{addressId}/delete/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":"/profile-business-individual-details/protectdeletekycprofileaddressdetailsbyprofileidandaddressid"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/profiles/{profileId}/details/addresses/{addressId}"}],"content":{"contentType":"group","meta":{"name":"Profile Business / Individual Details"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Profile Business / Individual Details","showPageActions":true},{"nodeType":"markdoc","content":"Endpoints to retrieve detailed information about businesses or individuals associated with a profile."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/compliance/kyc-protect/profiles/{profileId}/details","summary":"Return Profile Details","prefix":{"name":"get","color":"get"},"badges":[],"link":"/profile-business-individual-details/protectgetkycprofiledetails","deprecated":false},{"title":"/compliance/kyc-protect/profiles/{profileId}/details","summary":"Update Profile Details","prefix":{"name":"put","color":"put"},"badges":[],"link":"/profile-business-individual-details/protectputkycprofiledetails","deprecated":false},{"title":"/compliance/kyc-protect/profiles/{profileId}/details/addresses","summary":"Create An Address For A Profile","prefix":{"name":"post","color":"post"},"badges":[],"link":"/profile-business-individual-details/kycprotectcreatesanaddressfortheuser","deprecated":false},{"title":"/compliance/kyc-protect/profiles/{profileId}/details/addresses","summary":"Return Lists Of Addresses","prefix":{"name":"get","color":"get"},"badges":[],"link":"/profile-business-individual-details/kycprotectgetslistofaddresses","deprecated":false},{"title":"/compliance/kyc-protect/profiles/{profileId}/details/addresses/{addressId}","summary":"Return Profile Address Details By Profile And Address Id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/profile-business-individual-details/protectgetkycprofileaddressdetailsbyprofileidandaddressid","deprecated":false},{"title":"/compliance/kyc-protect/profiles/{profileId}/details/addresses/{addressId}","summary":"Update Profile Address Details By Profile Id And Address Id","prefix":{"name":"put","color":"put"},"badges":[],"link":"/profile-business-individual-details/protectputkycprofileaddressdetailsbyprofileidandaddressid","deprecated":false},{"title":"/compliance/kyc-protect/profiles/{profileId}/details/addresses/{addressId}","summary":"Delete Profile Address Details By Profile Id And Address Id","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/profile-business-individual-details/protectdeletekycprofileaddressdetailsbyprofileidandaddressid","deprecated":false}]}]}]}]}},{"type":"group","label":"Profile Key Parties","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-key-parties","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-key-parties","items":[{"label":"Create A Key Party Folder Linked To The Profile Id","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-key-parties/compliancepostkyckeypartiesbyprofileid","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-key-parties/compliancepostkyckeypartiesbyprofileid","metadata":{"seo":{"title":"Create A Key Party Folder Linked To The Profile Id","description":"Uses the details provided by the user to create key parties. Returns the created key parties information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"compliancePostKycKeyPartiesByProfileId","name":"Create A Key Party Folder Linked To The Profile Id","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1keyparties/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create A Key Party Folder Linked To The Profile Id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Uses the details provided by the user to create key parties. Returns the created key parties information."},{"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":"profileId","in":"path","schemaId":"schema_451","description":"id of the profile","required":true}],"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1keyparties/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PostKYCKeypartiesByProfileIdRequest"}},"schemaId":"components/schemas/PostKYCKeypartiesByProfileIdRequest","pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1keyparties/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/compliance/kyc-protect/profiles/{profileId}/keyparties","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"schemaId":"schema_451"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PostKYCKeypartiesByProfileIdRequest"}},"responseCodes":["201","400","401","403","404","409"],"pointer":"/compliance/kyc-protect/profiles/{profileId}/keyparties","href":"profile-key-parties/compliancepostkyckeypartiesbyprofileid","openApiOperationId":"compliancePostKycKeyPartiesByProfileId","summary":"Create A Key Party Folder Linked To The Profile 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"}],"schemaId":"components/schemas/PostKYCKeypartiesByProfileIdRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PostKYCKeypartiesByProfileIdRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_482"}},"schemaId":"schema_482"},{"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","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}],"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1keyparties/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_482","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_482"}}},{"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":"409","schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/profile-key-parties/compliancepostkyckeypartiesbyprofileid"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/profiles/{profileId}/keyparties"},{"label":"Return All Key Party Records Linked To A Profile","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-key-parties/compliancegetkyckeypartiesbyprofileid","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-key-parties/compliancegetkyckeypartiesbyprofileid","metadata":{"seo":{"title":"Return All Key Party Records Linked To A Profile","description":"This endpoint will return all created Key Party folders linked to the profile id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"complianceGetKycKeyPartiesByProfileId","name":"Return All Key Party Records Linked To A Profile","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1keyparties/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return All Key Party Records Linked To A Profile","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 all created Key Party folders linked to the profile 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":"profileId","in":"path","schemaId":"schema_451","description":"Id of the profile","required":true}],"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1keyparties/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"entityType","in":"query","schemaId":"schema_387","description":"Entity type of the key party. Avaialable values are individual, business."},{"name":"keyPartyTypes","in":"query","schemaId":"schema_449","description":"Type of the key party. Available values are director, shareholder, ubo and other."},{"name":"page","in":"query","schemaId":"schema_398","description":"Starting page number."},{"name":"pageSize","in":"query","schemaId":"schema_388","description":"Specifies the number of items to be displayed per page. Allowed values are between 1 and 100."}],"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1keyparties/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/compliance/kyc-protect/profiles/{profileId}/keyparties","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"schemaId":"schema_451"}],"query":[{"name":"entityType","in":"query","schemaId":"schema_387"},{"name":"keyPartyTypes","in":"query","schemaId":"schema_449"},{"name":"page","in":"query","schemaId":"schema_398"},{"name":"pageSize","in":"query","schemaId":"schema_388"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/compliance/kyc-protect/profiles/{profileId}/keyparties","href":"profile-key-parties/compliancegetkyckeypartiesbyprofileid","openApiOperationId":"complianceGetKycKeyPartiesByProfileId","summary":"Return All Key Party Records Linked To A Profile"},"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/GetKeyPartiesResponseByProfileId"}},"schemaId":"components/schemas/GetKeyPartiesResponseByProfileId"},{"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","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1keyparties/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetKeyPartiesResponseByProfileId","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetKeyPartiesResponseByProfileId"}}},{"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":"/profile-key-parties/compliancegetkyckeypartiesbyprofileid"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/profiles/{profileId}/keyparties"},{"label":"Update A Batch Of Key Parties","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-key-parties/complianceputkyckeypartiesbyprofileid","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-key-parties/complianceputkyckeypartiesbyprofileid","metadata":{"seo":{"title":"Update A Batch Of Key Parties","description":"Updates a batch of key parties"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"compliancePutKycKeyPartiesByProfileId","name":"Update A Batch Of Key Parties","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1keyparties/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update A Batch Of Key Parties","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates a batch of key parties"},{"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":"profileId","in":"path","schemaId":"schema_451","description":"id of the profile","required":true}],"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1keyparties/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PutKYCKeypartiesByProfileIdRequest"}},"schemaId":"components/schemas/PutKYCKeypartiesByProfileIdRequest","pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1keyparties/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/compliance/kyc-protect/profiles/{profileId}/keyparties","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"schemaId":"schema_451"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PutKYCKeypartiesByProfileIdRequest"}},"responseCodes":["200","400","401","403","404"],"pointer":"/compliance/kyc-protect/profiles/{profileId}/keyparties","href":"profile-key-parties/complianceputkyckeypartiesbyprofileid","openApiOperationId":"compliancePutKycKeyPartiesByProfileId","summary":"Update A Batch Of Key Parties"},"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/PutKYCKeypartiesByProfileIdRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PutKYCKeypartiesByProfileIdRequest"}},"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_483"}},"schemaId":"schema_483"},{"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","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1keyparties/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_483","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_483"}}},{"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":"/profile-key-parties/complianceputkyckeypartiesbyprofileid"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/profiles/{profileId}/keyparties"},{"label":"Delete a batch of key parties","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-key-parties/compliancedeletekyckeypartiesbyprofileid","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-key-parties/compliancedeletekyckeypartiesbyprofileid","metadata":{"seo":{"title":"Delete a batch of key parties","description":"Delete a selection of key parties from a specific profile."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"complianceDeleteKycKeyPartiesByProfileId","name":"Delete a batch of key parties","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1keyparties/delete","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a batch of key parties","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete a selection of key parties from a specific profile."},{"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":"profileId","in":"path","schemaId":"schema_451","description":"Id of the profile","required":true}],"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1keyparties/delete/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_484"}},"schemaId":"schema_484","pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1keyparties/delete/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/compliance/kyc-protect/profiles/{profileId}/keyparties","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"schemaId":"schema_451"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_484"}},"responseCodes":["200","400","401","403","404"],"pointer":"/compliance/kyc-protect/profiles/{profileId}/keyparties","href":"profile-key-parties/compliancedeletekyckeypartiesbyprofileid","openApiOperationId":"complianceDeleteKycKeyPartiesByProfileId","summary":"Delete a batch of key parties"},"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_484","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_484"}},"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/DeleteKeyPartiesResponseByProfileId"}},"schemaId":"components/schemas/DeleteKeyPartiesResponseByProfileId"},{"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","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1keyparties/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/DeleteKeyPartiesResponseByProfileId","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DeleteKeyPartiesResponseByProfileId"}}},{"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":"/profile-key-parties/compliancedeletekyckeypartiesbyprofileid"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/profiles/{profileId}/keyparties"},{"label":"Update The Key Party By Profile Id and Key Party Id","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-key-parties/complianceprotectputkycprofileskeypartiesbyprofileidandkeypartyid","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-key-parties/complianceprotectputkycprofileskeypartiesbyprofileidandkeypartyid","metadata":{"seo":{"title":"Update The Key Party By Profile Id and Key Party Id","description":"Updates a key party on a profile by Id. Returns the updated key party data."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"complianceProtectPutKycProfilesKeyPartiesByProfileIdAndKeyPartyId","name":"Update The Key Party By Profile Id and Key Party Id","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1keyparties~1{keyPartyId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update The Key Party By Profile Id and Key Party Id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates a key party on a profile by Id. Returns the updated key party data."},{"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":"profileId","in":"path","schemaId":"schema_451","description":"id of the profile","required":true},{"name":"keyPartyId","in":"path","schemaId":"schema_451","description":"id of the keyParty","required":true}],"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1keyparties~1{keyPartyId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateKeyPartyById"}},"schemaId":"components/schemas/UpdateKeyPartyById","pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1keyparties~1{keyPartyId}/put/requestBody","description":"Modified key party"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/compliance/kyc-protect/profiles/{profileId}/keyparties/{keyPartyId}","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"schemaId":"schema_451"},{"name":"keyPartyId","in":"path","required":true,"schemaId":"schema_451"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateKeyPartyById"}},"responseCodes":["200","400","401","403","404"],"pointer":"/compliance/kyc-protect/profiles/{profileId}/keyparties/{keyPartyId}","href":"profile-key-parties/complianceprotectputkycprofileskeypartiesbyprofileidandkeypartyid","openApiOperationId":"complianceProtectPutKycProfilesKeyPartiesByProfileIdAndKeyPartyId","summary":"Update The Key Party By Profile Id and Key Party 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"}],"schemaId":"components/schemas/UpdateKeyPartyById","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateKeyPartyById"}},"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/KeyPartyByIdReturn"}},"schemaId":"components/schemas/KeyPartyByIdReturn"},{"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","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1keyparties~1{keyPartyId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/KeyPartyByIdReturn","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KeyPartyByIdReturn"}}},{"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":"/profile-key-parties/complianceprotectputkycprofileskeypartiesbyprofileidandkeypartyid"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/profiles/{profileId}/keyparties/{keyPartyId}"},{"label":"Delete A Key Party By Key Party Id","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-key-parties/complianceprotectdeletekycprofileskeypartiesbyprofileidandkeypartyid","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-key-parties/complianceprotectdeletekycprofileskeypartiesbyprofileidandkeypartyid","metadata":{"seo":{"title":"Delete A Key Party By Key Party Id","description":"Delete a key party by Id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"complianceProtectDeleteKycProfilesKeyPartiesByProfileIdAndKeyPartyId","name":"Delete A Key Party By Key Party Id","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1keyparties~1{keyPartyId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete A Key Party By Key Party Id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete a key party 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":"profileId","in":"path","schemaId":"schema_451","description":"id of the profile","required":true},{"name":"keyPartyId","in":"path","schemaId":"schema_451","description":"id of the keyParty","required":true}],"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1keyparties~1{keyPartyId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/compliance/kyc-protect/profiles/{profileId}/keyparties/{keyPartyId}","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"schemaId":"schema_451"},{"name":"keyPartyId","in":"path","required":true,"schemaId":"schema_451"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","400","401","403","404"],"pointer":"/compliance/kyc-protect/profiles/{profileId}/keyparties/{keyPartyId}","href":"profile-key-parties/complianceprotectdeletekycprofileskeypartiesbyprofileidandkeypartyid","openApiOperationId":"complianceProtectDeleteKycProfilesKeyPartiesByProfileIdAndKeyPartyId","summary":"Delete A Key Party By Key Party 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":"204","description":"No Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DeleteKeyPartyByIdNoContent"}},"schemaId":"components/schemas/DeleteKeyPartyByIdNoContent"},{"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","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1keyparties~1{keyPartyId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204","schemaId":"components/schemas/DeleteKeyPartyByIdNoContent","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DeleteKeyPartyByIdNoContent"}}},{"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":"/profile-key-parties/complianceprotectdeletekycprofileskeypartiesbyprofileidandkeypartyid"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/profiles/{profileId}/keyparties/{keyPartyId}"},{"label":"Return All Key Party Searches","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-key-parties/compliancegetkyckeypartiessearches","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-key-parties/compliancegetkyckeypartiessearches","metadata":{"seo":{"title":"Return All Key Party Searches","description":"Get profile key party searches for the user."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"complianceGetKycKeyPartiesSearches","name":"Return All Key Party Searches","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1keyparties~1searches/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return All Key Party Searches","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get profile key party searches for the user."},{"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":"profileId","in":"path","schemaId":"schema_451","description":"id of the profile","required":true}],"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1keyparties~1searches/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_398","description":"Starting page number."},{"name":"pageSize","in":"query","schemaId":"schema_388","description":"Specifies the number of items to be displayed per page. Allowed values are between 1 and 100."},{"name":"type","in":"query","schemaId":"schema_387","description":"type of searches. Available values: individual, business"},{"name":"keyPartyTypes","in":"query","schemaId":"schema_387","description":"keyparty types. Available values: director, shareHolder, ubo"},{"name":"isScheduled","in":"query","schemaId":"schema_428","description":"schedule check."}],"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1keyparties~1searches/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/compliance/kyc-protect/profiles/{profileId}/keyparties/searches","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"schemaId":"schema_451"}],"query":[{"name":"page","in":"query","schemaId":"schema_398"},{"name":"pageSize","in":"query","schemaId":"schema_388"},{"name":"type","in":"query","schemaId":"schema_387"},{"name":"keyPartyTypes","in":"query","schemaId":"schema_387"},{"name":"isScheduled","in":"query","schemaId":"schema_428"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403"],"pointer":"/compliance/kyc-protect/profiles/{profileId}/keyparties/searches","href":"profile-key-parties/compliancegetkyckeypartiessearches","openApiOperationId":"complianceGetKycKeyPartiesSearches","summary":"Return All Key Party Searches"},"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/GetKeyPartySearchResponse"}},"schemaId":"components/schemas/GetKeyPartySearchResponse"},{"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/~1compliance~1kyc-protect~1profiles~1{profileId}~1keyparties~1searches/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetKeyPartySearchResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetKeyPartySearchResponse"}}},{"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":"/profile-key-parties/compliancegetkyckeypartiessearches"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/profiles/{profileId}/keyparties/searches"},{"label":"Delete A Batch Of Key Party Searches","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-key-parties/compliancedeletekyckeypartiessearches","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-key-parties/compliancedeletekyckeypartiessearches","metadata":{"seo":{"title":"Delete A Batch Of Key Party Searches","description":"Delete a batch of key parties searches"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"complianceDeleteKycKeyPartiesSearches","name":"Delete A Batch Of Key Party Searches","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1keyparties~1searches/delete","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete A Batch Of Key Party Searches","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete a batch of key parties searches"},{"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":"profileId","in":"path","schemaId":"schema_451","description":"id of the profile","required":true}],"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1keyparties~1searches/delete/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DeleteKeyPartySearchContractRequest"}},"schemaId":"components/schemas/DeleteKeyPartySearchContractRequest","pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1keyparties~1searches/delete/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/compliance/kyc-protect/profiles/{profileId}/keyparties/searches","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"schemaId":"schema_451"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/DeleteKeyPartySearchContractRequest"}},"responseCodes":["200","400","401","403"],"pointer":"/compliance/kyc-protect/profiles/{profileId}/keyparties/searches","href":"profile-key-parties/compliancedeletekyckeypartiessearches","openApiOperationId":"complianceDeleteKycKeyPartiesSearches","summary":"Delete A Batch Of Key Party Searches"},"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/DeleteKeyPartySearchContractRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DeleteKeyPartySearchContractRequest"}},"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/DeleteKeyPartySearchContractResponse"}},"schemaId":"components/schemas/DeleteKeyPartySearchContractResponse"},{"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/~1compliance~1kyc-protect~1profiles~1{profileId}~1keyparties~1searches/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/DeleteKeyPartySearchContractResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DeleteKeyPartySearchContractResponse"}}},{"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":"/profile-key-parties/compliancedeletekyckeypartiessearches"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/profiles/{profileId}/keyparties/searches"},{"label":"Request Multiple Searches Linked To A Key Party Asynchronously","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-key-parties/compliancepostkyckeypartiessearchesbulkbyprofileid","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-key-parties/compliancepostkyckeypartiessearchesbulkbyprofileid","metadata":{"seo":{"title":"Request Multiple Searches Linked To A Key Party Asynchronously","description":"Request multiple searches to be performed and linked to a key party asynchronously"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"compliancePostKycKeyPartiesSearchesBulkByProfileId","name":"Request Multiple Searches Linked To A Key Party Asynchronously","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1keyparties~1searches~1bulk/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Request Multiple Searches Linked To A Key Party Asynchronously","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Request multiple searches to be performed and linked to a key party asynchronously"},{"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":"profileId","in":"path","schemaId":"schema_451","description":"id of the profile","required":true}],"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1keyparties~1searches~1bulk/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_485"}},"schemaId":"schema_485","pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1keyparties~1searches~1bulk/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/compliance/kyc-protect/profiles/{profileId}/keyparties/searches/bulk","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"schemaId":"schema_451"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_485"}},"responseCodes":["202","400","401","403","404"],"pointer":"/compliance/kyc-protect/profiles/{profileId}/keyparties/searches/bulk","href":"profile-key-parties/compliancepostkyckeypartiessearchesbulkbyprofileid","openApiOperationId":"compliancePostKycKeyPartiesSearchesBulkByProfileId","summary":"Request Multiple Searches Linked To A Key Party Asynchronously"},"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_485","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_485"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Accepted"},{"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/~1compliance~1kyc-protect~1profiles~1{profileId}~1keyparties~1searches~1bulk/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202"},{"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":"/profile-key-parties/compliancepostkyckeypartiessearchesbulkbyprofileid"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/profiles/{profileId}/keyparties/searches/bulk"},{"label":"Link Searches To Key Parties","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-key-parties/compliancepostkyckeypartiessearcheslinkbyprofileid","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-key-parties/compliancepostkyckeypartiessearcheslinkbyprofileid","metadata":{"seo":{"title":"Link Searches To Key Parties","description":"Add searches link to key parties for the current logged in user."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"compliancePostKycKeyPartiesSearchesLinkByProfileId","name":"Link Searches To Key Parties","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1keyparties~1searches~1link/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Link Searches To Key Parties","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Add searches link to key parties for the current logged in user."},{"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":"profileId","in":"path","schemaId":"schema_451","description":"id of the profile","required":true}],"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1keyparties~1searches~1link/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_486"}},"schemaId":"schema_486","pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1keyparties~1searches~1link/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/compliance/kyc-protect/profiles/{profileId}/keyparties/searches/link","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"schemaId":"schema_451"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_486"}},"responseCodes":["201","400","401","403","404","409"],"pointer":"/compliance/kyc-protect/profiles/{profileId}/keyparties/searches/link","href":"profile-key-parties/compliancepostkyckeypartiessearcheslinkbyprofileid","openApiOperationId":"compliancePostKycKeyPartiesSearchesLinkByProfileId","summary":"Link Searches To Key Parties"},"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_486","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_486"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PostKYCKeypartiesSearchesLinkByProfileIdResponse"}},"schemaId":"components/schemas/PostKYCKeypartiesSearchesLinkByProfileIdResponse"},{"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","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}],"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1keyparties~1searches~1link/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/PostKYCKeypartiesSearchesLinkByProfileIdResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PostKYCKeypartiesSearchesLinkByProfileIdResponse"}}},{"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":"409","schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/profile-key-parties/compliancepostkyckeypartiessearcheslinkbyprofileid"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/profiles/{profileId}/keyparties/searches/link"}],"content":{"contentType":"group","meta":{"name":"Profile Key Parties"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Profile Key Parties","showPageActions":true},{"nodeType":"markdoc","content":"Endpoints to manage key parties associated with a profile, such as directors, shareholders, or UBOs."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/compliance/kyc-protect/profiles/{profileId}/keyparties","summary":"Create A Key Party Folder Linked To The Profile Id","prefix":{"name":"post","color":"post"},"badges":[],"link":"/profile-key-parties/compliancepostkyckeypartiesbyprofileid","deprecated":false},{"title":"/compliance/kyc-protect/profiles/{profileId}/keyparties","summary":"Return All Key Party Records Linked To A Profile","prefix":{"name":"get","color":"get"},"badges":[],"link":"/profile-key-parties/compliancegetkyckeypartiesbyprofileid","deprecated":false},{"title":"/compliance/kyc-protect/profiles/{profileId}/keyparties","summary":"Update A Batch Of Key Parties","prefix":{"name":"put","color":"put"},"badges":[],"link":"/profile-key-parties/complianceputkyckeypartiesbyprofileid","deprecated":false},{"title":"/compliance/kyc-protect/profiles/{profileId}/keyparties","summary":"Delete a batch of key parties","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/profile-key-parties/compliancedeletekyckeypartiesbyprofileid","deprecated":false},{"title":"/compliance/kyc-protect/profiles/{profileId}/keyparties/{keyPartyId}","summary":"Update The Key Party By Profile Id and Key Party Id","prefix":{"name":"put","color":"put"},"badges":[],"link":"/profile-key-parties/complianceprotectputkycprofileskeypartiesbyprofileidandkeypartyid","deprecated":false},{"title":"/compliance/kyc-protect/profiles/{profileId}/keyparties/{keyPartyId}","summary":"Delete A Key Party By Key Party Id","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/profile-key-parties/complianceprotectdeletekycprofileskeypartiesbyprofileidandkeypartyid","deprecated":false},{"title":"/compliance/kyc-protect/profiles/{profileId}/keyparties/searches","summary":"Return All Key Party Searches","prefix":{"name":"get","color":"get"},"badges":[],"link":"/profile-key-parties/compliancegetkyckeypartiessearches","deprecated":false},{"title":"/compliance/kyc-protect/profiles/{profileId}/keyparties/searches","summary":"Delete A Batch Of Key Party Searches","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/profile-key-parties/compliancedeletekyckeypartiessearches","deprecated":false},{"title":"/compliance/kyc-protect/profiles/{profileId}/keyparties/searches/bulk","summary":"Request Multiple Searches Linked To A Key Party Asynchronously","prefix":{"name":"post","color":"post"},"badges":[],"link":"/profile-key-parties/compliancepostkyckeypartiessearchesbulkbyprofileid","deprecated":false},{"title":"/compliance/kyc-protect/profiles/{profileId}/keyparties/searches/link","summary":"Link Searches To Key Parties","prefix":{"name":"post","color":"post"},"badges":[],"link":"/profile-key-parties/compliancepostkyckeypartiessearcheslinkbyprofileid","deprecated":false}]}]}]}]}},{"type":"group","label":"Profile Management","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-management","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-management","items":[{"label":"Create Profile","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-management/kycprotectcreateprofile","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-management/kycprotectcreateprofile","metadata":{"seo":{"title":"Create Profile","description":"Uses the name and type provided by the user to create a profile."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"kycProtectCreateProfile","name":"Create Profile","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1profiles/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Profile","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Uses the name and type provided by the user to create a profile."},{"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/KycProtectPostProfilesRequest"}},"schemaId":"components/schemas/KycProtectPostProfilesRequest","pointer":"/paths/~1compliance~1kyc-protect~1profiles/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/compliance/kyc-protect/profiles","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/KycProtectPostProfilesRequest"}},"responseCodes":["201","400","401","403","409"],"pointer":"/compliance/kyc-protect/profiles","href":"profile-management/kycprotectcreateprofile","openApiOperationId":"kycProtectCreateProfile","summary":"Create Profile"},"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/KycProtectPostProfilesRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/KycProtectPostProfilesRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KycProtectProfileCreatedResponse"}},"schemaId":"components/schemas/KycProtectProfileCreatedResponse"},{"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":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}],"pointer":"/paths/~1compliance~1kyc-protect~1profiles/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/KycProtectProfileCreatedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KycProtectProfileCreatedResponse"}}},{"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":"409","schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/profile-management/kycprotectcreateprofile"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/profiles"},{"label":"Return Created Profiles","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-management/complianceprotectgetkycprofiles","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-management/complianceprotectgetkycprofiles","metadata":{"seo":{"title":"Return Created Profiles","description":"Returns a list of profiles ordered by modified date."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"complianceProtectGetKycProfiles","name":"Return Created Profiles","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1profiles/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return Created Profiles","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a list of profiles ordered by modified date."},{"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_398","description":"Starting page number."},{"name":"pageSize","in":"query","schemaId":"schema_388","description":"Specifies the number of items to be displayed per page. Allowed values are between 1 and 100."},{"name":"searchTerm","in":"query","schemaId":"schema_387","description":"A search term to filter by. The search term will be matched against names, and internal ids containing the search term."},{"name":"assignees","in":"query","schemaId":"schema_471","description":"The ids of assigned users to filter by."},{"name":"kycReviewAfter","in":"query","schemaId":"schema_478","description":"Filters results based on profiles with a kyc review date after this date."},{"name":"kycReviewBefore","in":"query","schemaId":"schema_478","description":"Filters results based on profiles with a kyc review date after this date."},{"name":"riskRatings","in":"query","schemaId":"schema_449","description":"The risk ratings to filter by. Available values: notApplicable, veryLow, low, medium, high, veryHigh"},{"name":"sortOrder","in":"query","schemaId":"schema_387","description":"The order in which the items should be sorted. Available values: asc, desc"},{"name":"sortBy","in":"query","schemaId":"schema_387","description":"The field by which the items should be sorted. Available values: modifiedAt, name"},{"name":"statuses","in":"query","schemaId":"schema_449","description":"The statuses to filter by. Available values: new, approved, declined, pending, cancelled, referred, closed, approvedReviewDue"}],"pointer":"/paths/~1compliance~1kyc-protect~1profiles/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/compliance/kyc-protect/profiles","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_398"},{"name":"pageSize","in":"query","schemaId":"schema_388"},{"name":"searchTerm","in":"query","schemaId":"schema_387"},{"name":"assignees","in":"query","schemaId":"schema_471"},{"name":"kycReviewAfter","in":"query","schemaId":"schema_478"},{"name":"kycReviewBefore","in":"query","schemaId":"schema_478"},{"name":"riskRatings","in":"query","schemaId":"schema_449"},{"name":"sortOrder","in":"query","schemaId":"schema_387"},{"name":"sortBy","in":"query","schemaId":"schema_387"},{"name":"statuses","in":"query","schemaId":"schema_449"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403"],"pointer":"/compliance/kyc-protect/profiles","href":"profile-management/complianceprotectgetkycprofiles","openApiOperationId":"complianceProtectGetKycProfiles","summary":"Return Created Profiles"},"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/GetKYCProfiles"}},"schemaId":"components/schemas/GetKYCProfiles"},{"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/~1compliance~1kyc-protect~1profiles/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetKYCProfiles","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetKYCProfiles"}}},{"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":"/profile-management/complianceprotectgetkycprofiles"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/profiles"},{"label":"Delete All Profiles","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-management/complianceprotectdeletekycprofiles","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-management/complianceprotectdeletekycprofiles","metadata":{"seo":{"title":"Delete All Profiles","description":"Deletes list of profiles. This will delete all its dependencies/child items associated to that profileId."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"complianceProtectDeleteKycProfiles","name":"Delete All Profiles","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1profiles/delete","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete All Profiles","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":"Deletes list of profiles. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This will delete all its dependencies/child items associated to that profileId."},"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/DeleteKYCProfiles"}},"schemaId":"components/schemas/DeleteKYCProfiles","pointer":"/paths/~1compliance~1kyc-protect~1profiles/delete/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/compliance/kyc-protect/profiles","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/DeleteKYCProfiles"}},"responseCodes":["204","400","401","403","404"],"pointer":"/compliance/kyc-protect/profiles","href":"profile-management/complianceprotectdeletekycprofiles","openApiOperationId":"complianceProtectDeleteKycProfiles","summary":"Delete All Profiles"},"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/DeleteKYCProfiles","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DeleteKYCProfiles"}},"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","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_428"}},"schemaId":"schema_428"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"},{"code":"401","description":"Invalid Token","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}},"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"},{"code":"403","description":"Access Forbidden","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/~1compliance~1kyc-protect~1profiles/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204","schemaId":"schema_428","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_428"}}},{"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":"/profile-management/complianceprotectdeletekycprofiles"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/profiles"},{"label":"Return Profile By Profile Id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-management/protectgetkycprofilesbyprofileid","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-management/protectgetkycprofilesbyprofileid","metadata":{"seo":{"title":"Return Profile By Profile Id","description":"Returns a single profile by id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"protectGetKycProfilesByProfileId","name":"Return Profile By Profile Id","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return Profile By Profile Id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a single profile 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":"profileId","in":"path","schemaId":"schema_387","description":"Id of a profile.","required":true,"example":"9a7ae0c8-f473-4ab6-8dbb-03fc061630cc"}],"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/compliance/kyc-protect/profiles/{profileId}","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"example":"9a7ae0c8-f473-4ab6-8dbb-03fc061630cc","schemaId":"schema_387"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/compliance/kyc-protect/profiles/{profileId}","href":"profile-management/protectgetkycprofilesbyprofileid","openApiOperationId":"protectGetKycProfilesByProfileId","summary":"Return Profile By Profile 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/GetKYCProfileByProfileId"}},"schemaId":"components/schemas/GetKYCProfileByProfileId"},{"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","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetKYCProfileByProfileId","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetKYCProfileByProfileId"}}},{"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":"/profile-management/protectgetkycprofilesbyprofileid"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/profiles/{profileId}"},{"label":"Delete Profile By Profile Id","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-management/protectdeletekycprofilesbyid","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-management/protectdeletekycprofilesbyid","metadata":{"seo":{"title":"Delete Profile By Profile Id","description":"Deletes a single profile by id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"protectDeleteKycProfilesById","name":"Delete Profile By Profile Id","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Profile By Profile Id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a single profile 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":"profileId","in":"path","schemaId":"schema_387","description":"Id of a profile.","required":true,"example":"9a7ae0c8-f473-4ab6-8dbb-03fc061630cc"}],"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/compliance/kyc-protect/profiles/{profileId}","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"example":"9a7ae0c8-f473-4ab6-8dbb-03fc061630cc","schemaId":"schema_387"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","400","401","403","404"],"pointer":"/compliance/kyc-protect/profiles/{profileId}","href":"profile-management/protectdeletekycprofilesbyid","openApiOperationId":"protectDeleteKycProfilesById","summary":"Delete Profile By Profile 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":"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","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}/delete/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":"/profile-management/protectdeletekycprofilesbyid"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/profiles/{profileId}"},{"label":"Assign Profile To User","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-management/protectassignprofiles","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-management/protectassignprofiles","metadata":{"seo":{"title":"Assign Profile To User","description":"Assign a profile to a user"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"protectAssignProfiles","name":"Assign Profile To User","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1assign/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Assign Profile To User","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Assign a profile to a user"},{"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":"profileId","in":"query","schemaId":"schema_387","description":"Id of the profile being assigned to a user","required":true},{"name":"userId","in":"query","schemaId":"schema_387","description":"User Id to assign the Profile to"}],"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1assign/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/compliance/kyc-protect/profiles/assign","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[],"query":[{"name":"profileId","in":"query","required":true,"schemaId":"schema_387"},{"name":"userId","in":"query","schemaId":"schema_387"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/compliance/kyc-protect/profiles/assign","href":"profile-management/protectassignprofiles","openApiOperationId":"protectAssignProfiles","summary":"Assign Profile To User"},"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/PutKYCProfileAssign"}},"schemaId":"components/schemas/PutKYCProfileAssign"},{"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","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1assign/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PutKYCProfileAssign","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PutKYCProfileAssign"}}},{"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":"/profile-management/protectassignprofiles"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/profiles/assign"},{"label":"Assigns A List Of Profiles To User","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-management/kycprotectassignslistofprofilestouser","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-management/kycprotectassignslistofprofilestouser","metadata":{"seo":{"title":"Assigns A List Of Profiles To User","description":"Assigns list of profiles to a user."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"kycProtectAssignsListOfProfilesToUser","name":"Assigns A List Of Profiles To User","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1assign~1bulk/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Assigns A List Of Profiles To User","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Assigns list of profiles to a user."},{"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/MODEL4df4ca"}},"schemaId":"components/schemas/MODEL4df4ca","pointer":"/paths/~1compliance~1kyc-protect~1profiles~1assign~1bulk/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/compliance/kyc-protect/profiles/assign/bulk","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/MODEL4df4ca"}},"responseCodes":["200","400","401","403","404"],"pointer":"/compliance/kyc-protect/profiles/assign/bulk","href":"profile-management/kycprotectassignslistofprofilestouser","openApiOperationId":"kycProtectAssignsListOfProfilesToUser","summary":"Assigns A List Of Profiles To User"},"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/MODEL4df4ca","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/MODEL4df4ca"}},"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_487"}},"schemaId":"schema_487"},{"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/~1compliance~1kyc-protect~1profiles~1assign~1bulk/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_487","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_487"}}},{"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":"/profile-management/kycprotectassignslistofprofilestouser"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/profiles/assign/bulk"},{"label":"Create Profile From Company Report","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-management/compliancepostkycprofilebusinessesimports","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-management/compliancepostkycprofilebusinessesimports","metadata":{"seo":{"title":"Create Profile From Company Report","description":"Imports a company business report into the system as a profile for compliance purposes."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"compliancePostKycProfileBusinessesImports","name":"Create Profile From Company Report","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1businesses~1import/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Profile From Company Report","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Imports a company business report into the system as a profile for compliance purposes.\n"},{"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":"language","in":"query","schemaId":"schema_423","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_488","description":"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."},{"name":"includeIndicators","in":"query","schemaId":"schema_489","description":"Optional parameter flag to include indicators or not."},{"name":"customData","in":"query","schemaId":"schema_411","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":"reportSections","in":"query","schemaId":"schema_387","description":"Optional parameter to get specific sections of report instead  of entire report."},{"name":"languageFallback","in":"query","schemaId":"schema_392","description":"Optional parameter flag to request a report with default language."},{"name":"callRef","in":"query","schemaId":"schema_410","description":"Call Reference"}],"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1businesses~1import/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PostKYCProfileImportBusinessesRequest"}},"schemaId":"components/schemas/PostKYCProfileImportBusinessesRequest","pointer":"/paths/~1compliance~1kyc-protect~1profiles~1businesses~1import/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/compliance/kyc-protect/profiles/businesses/import","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[],"query":[{"name":"language","in":"query","schemaId":"schema_423"},{"name":"template","in":"query","schemaId":"schema_488"},{"name":"includeIndicators","in":"query","schemaId":"schema_489"},{"name":"customData","in":"query","schemaId":"schema_411"},{"name":"reportSections","in":"query","schemaId":"schema_387"},{"name":"languageFallback","in":"query","schemaId":"schema_392"},{"name":"callRef","in":"query","required":false,"schemaId":"schema_410"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PostKYCProfileImportBusinessesRequest"}},"responseCodes":["202","400","401","403","404","409"],"pointer":"/compliance/kyc-protect/profiles/businesses/import","href":"profile-management/compliancepostkycprofilebusinessesimports","openApiOperationId":"compliancePostKycProfileBusinessesImports","summary":"Create Profile From Company 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"}],"schemaId":"components/schemas/PostKYCProfileImportBusinessesRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PostKYCProfileImportBusinessesRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_490"}},"schemaId":"schema_490"},{"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":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}],"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1businesses~1import/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"schema_490","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_490"}}},{"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":"409","schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/profile-management/compliancepostkycprofilebusinessesimports"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/profiles/businesses/import"}],"content":{"contentType":"group","meta":{"name":"Profile Management"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Profile Management","showPageActions":true},{"nodeType":"markdoc","content":"Endpoints to create, retrieve, and manage profiles."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/compliance/kyc-protect/profiles","summary":"Create Profile","prefix":{"name":"post","color":"post"},"badges":[],"link":"/profile-management/kycprotectcreateprofile","deprecated":false},{"title":"/compliance/kyc-protect/profiles","summary":"Return Created Profiles","prefix":{"name":"get","color":"get"},"badges":[],"link":"/profile-management/complianceprotectgetkycprofiles","deprecated":false},{"title":"/compliance/kyc-protect/profiles","summary":"Delete All Profiles","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/profile-management/complianceprotectdeletekycprofiles","deprecated":false},{"title":"/compliance/kyc-protect/profiles/{profileId}","summary":"Return Profile By Profile Id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/profile-management/protectgetkycprofilesbyprofileid","deprecated":false},{"title":"/compliance/kyc-protect/profiles/{profileId}","summary":"Delete Profile By Profile Id","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/profile-management/protectdeletekycprofilesbyid","deprecated":false},{"title":"/compliance/kyc-protect/profiles/assign","summary":"Assign Profile To User","prefix":{"name":"put","color":"put"},"badges":[],"link":"/profile-management/protectassignprofiles","deprecated":false},{"title":"/compliance/kyc-protect/profiles/assign/bulk","summary":"Assigns A List Of Profiles To User","prefix":{"name":"put","color":"put"},"badges":[],"link":"/profile-management/kycprotectassignslistofprofilestouser","deprecated":false},{"title":"/compliance/kyc-protect/profiles/businesses/import","summary":"Create Profile From Company Report","prefix":{"name":"post","color":"post"},"badges":[],"link":"/profile-management/compliancepostkycprofilebusinessesimports","deprecated":false}]}]}]}]}},{"type":"group","label":"Profile Updates","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-updates","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-updates","items":[{"label":"Update Profile By Profile Id","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-updates/protectupdateskycprofilebyid","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-updates/protectupdateskycprofilebyid","metadata":{"seo":{"title":"Update Profile By Profile Id","description":"Updates a single profile by profile Id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"protectUpdatesKycProfileById","name":"Update Profile By Profile Id","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Profile By Profile Id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates a single profile by profile 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":"profileId","in":"path","schemaId":"schema_387","description":"Id of a profile.","required":true,"example":"9a7ae0c8-f473-4ab6-8dbb-03fc061630cc"}],"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateKYCProfileByProfileIdRequest"}},"schemaId":"components/schemas/UpdateKYCProfileByProfileIdRequest","pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/compliance/kyc-protect/profiles/{profileId}","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"example":"9a7ae0c8-f473-4ab6-8dbb-03fc061630cc","schemaId":"schema_387"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateKYCProfileByProfileIdRequest"}},"responseCodes":["200","400","401","403","404","409"],"pointer":"/compliance/kyc-protect/profiles/{profileId}","href":"profile-updates/protectupdateskycprofilebyid","openApiOperationId":"protectUpdatesKycProfileById","summary":"Update Profile By Profile 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"}],"schemaId":"components/schemas/UpdateKYCProfileByProfileIdRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateKYCProfileByProfileIdRequest"}},"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/UpdateKYCProfileByProfileId"}},"schemaId":"components/schemas/UpdateKYCProfileByProfileId"},{"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","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}],"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/UpdateKYCProfileByProfileId","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UpdateKYCProfileByProfileId"}}},{"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":"409","schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/profile-updates/protectupdateskycprofilebyid"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/profiles/{profileId}"},{"label":"Add An Attachment To The Given Profile","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-updates/kycprotectaddanattachmenttothegivenprofile","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-updates/kycprotectaddanattachmenttothegivenprofile","metadata":{"seo":{"title":"Add An Attachment To The Given Profile","description":"Adds an attachment to a profile. Returns the details of the added attachment."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"kycProtectAddAnAttachmentToTheGivenProfile","name":"Add An Attachment To The Given Profile","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1attachments/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add An Attachment To The Given Profile","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Adds an attachment to a profile. Returns the details of the added attachment."},{"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":"profileId","in":"path","schemaId":"schema_451","description":"id of the profile","required":true}],"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1attachments/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_491"}},"schemaId":"schema_491","pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1attachments/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/compliance/kyc-protect/profiles/{profileId}/attachments","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"schemaId":"schema_451"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"schema_491"}},"responseCodes":["201","400","401","403","404","409"],"pointer":"/compliance/kyc-protect/profiles/{profileId}/attachments","href":"profile-updates/kycprotectaddanattachmenttothegivenprofile","openApiOperationId":"kycProtectAddAnAttachmentToTheGivenProfile","summary":"Add An Attachment To The Given Profile"},"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_491","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_491"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KycProtectProfileAttachmentResponse"}},"schemaId":"components/schemas/KycProtectProfileAttachmentResponse"},{"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":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}],"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1attachments/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/KycProtectProfileAttachmentResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KycProtectProfileAttachmentResponse"}}},{"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":"409","schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/profile-updates/kycprotectaddanattachmenttothegivenprofile"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/profiles/{profileId}/attachments"},{"label":"Return List Of Attachments On The Given Profile","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-updates/kycprotectgetlistofattachmentsonthegivenprofile","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-updates/kycprotectgetlistofattachmentsonthegivenprofile","metadata":{"seo":{"title":"Return List Of Attachments On The Given Profile","description":"Gets a list of attachments on the given profile ordered by modified date."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"kycProtectGetListOfAttachmentsOnTheGivenProfile","name":"Return List Of Attachments On The Given Profile","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1attachments/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return List Of Attachments On The Given Profile","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets a list of attachments on the given profile ordered by modified date."},{"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":"profileId","in":"path","schemaId":"schema_451","description":"id of the profile","required":true}],"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1attachments/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_471","description":"The page number to fetch. Should be a positive integer."},{"name":"pageSize","in":"query","schemaId":"schema_388","description":"Specifies the number of items to be displayed per page. Allowed values are between 1 and 100."}],"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1attachments/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/compliance/kyc-protect/profiles/{profileId}/attachments","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"schemaId":"schema_451"}],"query":[{"name":"page","in":"query","schemaId":"schema_471"},{"name":"pageSize","in":"query","schemaId":"schema_388"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/compliance/kyc-protect/profiles/{profileId}/attachments","href":"profile-updates/kycprotectgetlistofattachmentsonthegivenprofile","openApiOperationId":"kycProtectGetListOfAttachmentsOnTheGivenProfile","summary":"Return List Of Attachments On The Given Profile"},"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":"schema_492"}},"schemaId":"schema_492"},{"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/~1compliance~1kyc-protect~1profiles~1{profileId}~1attachments/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_492","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_492"}}},{"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":"/profile-updates/kycprotectgetlistofattachmentsonthegivenprofile"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/profiles/{profileId}/attachments"},{"label":"Return A Profile Attachment By Profile And Attachment Id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-updates/protectgetkycprofileattachmentbyprofileidandattachmentid","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-updates/protectgetkycprofileattachmentbyprofileidandattachmentid","metadata":{"seo":{"title":"Return A Profile Attachment By Profile And Attachment Id","description":"Returns an attachment by the provided attachment Id and profile Id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"protectGETKYCProfileAttachmentByProfileIdAndAttachmentId","name":"Return A Profile Attachment By Profile And Attachment Id","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1attachments~1{attachmentId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return A Profile Attachment By Profile And Attachment Id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns an attachment by the provided attachment Id and profile 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":"profileId","in":"path","schemaId":"schema_451","description":"Id of a profile.","required":true,"example":"9a7ae0c8-f473-4ab6-8dbb-03fc061630cc"},{"name":"attachmentId","in":"path","schemaId":"schema_451","description":"Id of an attachment.","required":true,"example":"24faad02-7e20-4912-bdd9-51e4797380c5"}],"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1attachments~1{attachmentId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/compliance/kyc-protect/profiles/{profileId}/attachments/{attachmentId}","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"example":"9a7ae0c8-f473-4ab6-8dbb-03fc061630cc","schemaId":"schema_451"},{"name":"attachmentId","in":"path","required":true,"example":"24faad02-7e20-4912-bdd9-51e4797380c5","schemaId":"schema_451"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/compliance/kyc-protect/profiles/{profileId}/attachments/{attachmentId}","href":"profile-updates/protectgetkycprofileattachmentbyprofileidandattachmentid","openApiOperationId":"protectGETKYCProfileAttachmentByProfileIdAndAttachmentId","summary":"Return A Profile Attachment By Profile And Attachment 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/GetKYCProfileAttachmentDetailsByAttachmentId"}},"schemaId":"components/schemas/GetKYCProfileAttachmentDetailsByAttachmentId"},{"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","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1attachments~1{attachmentId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetKYCProfileAttachmentDetailsByAttachmentId","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetKYCProfileAttachmentDetailsByAttachmentId"}}},{"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":"/profile-updates/protectgetkycprofileattachmentbyprofileidandattachmentid"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/profiles/{profileId}/attachments/{attachmentId}"},{"label":"Update Profile Attachment By Profile And Attachment Id","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-updates/protectputkycprofileattachmentbyprofileidandattachmentid","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-updates/protectputkycprofileattachmentbyprofileidandattachmentid","metadata":{"seo":{"title":"Update Profile Attachment By Profile And Attachment Id","description":"Updates A Profile Attachment By Profile And Attachment Id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"protectPutKYCProfileAttachmentByProfileIdAndAttachmentId","name":"Update Profile Attachment By Profile And Attachment Id","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1attachments~1{attachmentId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Profile Attachment By Profile And Attachment Id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates A Profile Attachment By Profile And Attachment 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":"profileId","in":"path","schemaId":"schema_451","description":"Id of a profile.","required":true,"example":"9a7ae0c8-f473-4ab6-8dbb-03fc061630cc"},{"name":"attachmentId","in":"path","schemaId":"schema_451","description":"Id of a attachmentId.","required":true,"example":"9a7ae0c8-f473-4ab6-8dbb-03fc061630cc"}],"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1attachments~1{attachmentId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/UpdateKYCAttachmentsByAttachmentIdRequest"}},"schemaId":"components/schemas/UpdateKYCAttachmentsByAttachmentIdRequest","pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1attachments~1{attachmentId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/compliance/kyc-protect/profiles/{profileId}/attachments/{attachmentId}","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"example":"9a7ae0c8-f473-4ab6-8dbb-03fc061630cc","schemaId":"schema_451"},{"name":"attachmentId","in":"path","required":true,"example":"9a7ae0c8-f473-4ab6-8dbb-03fc061630cc","schemaId":"schema_451"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"components/schemas/UpdateKYCAttachmentsByAttachmentIdRequest"}},"responseCodes":["200","400","401","403","404","409"],"pointer":"/compliance/kyc-protect/profiles/{profileId}/attachments/{attachmentId}","href":"profile-updates/protectputkycprofileattachmentbyprofileidandattachmentid","openApiOperationId":"protectPutKYCProfileAttachmentByProfileIdAndAttachmentId","summary":"Update Profile Attachment By Profile And Attachment 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"}],"schemaId":"components/schemas/UpdateKYCAttachmentsByAttachmentIdRequest","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/UpdateKYCAttachmentsByAttachmentIdRequest"}},"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/UpdateKYCAttachmentsByAttachmentId"}},"schemaId":"components/schemas/UpdateKYCAttachmentsByAttachmentId"},{"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","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}],"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1attachments~1{attachmentId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/UpdateKYCAttachmentsByAttachmentId","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UpdateKYCAttachmentsByAttachmentId"}}},{"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":"409","schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/profile-updates/protectputkycprofileattachmentbyprofileidandattachmentid"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/profiles/{profileId}/attachments/{attachmentId}"},{"label":"Delete Attachment By Profile And Attachment Id","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-updates/protectdeletekycprofileattachmentbyprofileidandattachmentid","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-updates/protectdeletekycprofileattachmentbyprofileidandattachmentid","metadata":{"seo":{"title":"Delete Attachment By Profile And Attachment Id","description":"Deletes A Profile Attachment By Profile And Attachment Id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"protectDeleteKYCProfileAttachmentByProfileIdAndAttachmentId","name":"Delete Attachment By Profile And Attachment Id","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1attachments~1{attachmentId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Attachment By Profile And Attachment Id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes A Profile Attachment By Profile And Attachment 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":"profileId","in":"path","schemaId":"schema_451","description":"Id of a profile.","required":true,"example":"9a7ae0c8-f473-4ab6-8dbb-03fc061630cc"},{"name":"attachmentId","in":"path","schemaId":"schema_451","description":"Id of a attachmentId.","required":true,"example":"9a7ae0c8-f473-4ab6-8dbb-03fc061630cc"}],"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1attachments~1{attachmentId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/compliance/kyc-protect/profiles/{profileId}/attachments/{attachmentId}","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"example":"9a7ae0c8-f473-4ab6-8dbb-03fc061630cc","schemaId":"schema_451"},{"name":"attachmentId","in":"path","required":true,"example":"9a7ae0c8-f473-4ab6-8dbb-03fc061630cc","schemaId":"schema_451"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","400","401","403","404","409"],"pointer":"/compliance/kyc-protect/profiles/{profileId}/attachments/{attachmentId}","href":"profile-updates/protectdeletekycprofileattachmentbyprofileidandattachmentid","openApiOperationId":"protectDeleteKYCProfileAttachmentByProfileIdAndAttachmentId","summary":"Delete Attachment By Profile And Attachment 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":"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","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}],"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1attachments~1{attachmentId}/delete/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"}}},{"code":"409","schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/profile-updates/protectdeletekycprofileattachmentbyprofileidandattachmentid"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/profiles/{profileId}/attachments/{attachmentId}"},{"label":"Download Profile Attachment By Profile And Attachment Id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-updates/protectdownloadkycprofileattachmentbyprofileidandattachmentid","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-updates/protectdownloadkycprofileattachmentbyprofileidandattachmentid","metadata":{"seo":{"title":"Download Profile Attachment By Profile And Attachment Id","description":"Gets profile attachment's download link."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"protectDownloadKYCProfileAttachmentByProfileIdAndAttachmentId","name":"Download Profile Attachment By Profile And Attachment Id","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1attachments~1{attachmentId}~1download/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download Profile Attachment By Profile And Attachment Id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets profile attachment's download link."},{"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":"profileId","in":"path","schemaId":"schema_451","description":"Id of a profile.","required":true,"example":"9a7ae0c8-f473-4ab6-8dbb-03fc061630cc"},{"name":"attachmentId","in":"path","schemaId":"schema_451","description":"Id of an attachment.","required":true,"example":"24faad02-7e20-4912-bdd9-51e4797380c5"}],"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1attachments~1{attachmentId}~1download/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/compliance/kyc-protect/profiles/{profileId}/attachments/{attachmentId}/download","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"example":"9a7ae0c8-f473-4ab6-8dbb-03fc061630cc","schemaId":"schema_451"},{"name":"attachmentId","in":"path","required":true,"example":"24faad02-7e20-4912-bdd9-51e4797380c5","schemaId":"schema_451"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/compliance/kyc-protect/profiles/{profileId}/attachments/{attachmentId}/download","href":"profile-updates/protectdownloadkycprofileattachmentbyprofileidandattachmentid","openApiOperationId":"protectDownloadKYCProfileAttachmentByProfileIdAndAttachmentId","summary":"Download Profile Attachment By Profile And Attachment 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/DownloadAttachmentResponse"}},"schemaId":"components/schemas/DownloadAttachmentResponse"},{"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","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1attachments~1{attachmentId}~1download/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/DownloadAttachmentResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DownloadAttachmentResponse"}}},{"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":"/profile-updates/protectdownloadkycprofileattachmentbyprofileidandattachmentid"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/profiles/{profileId}/attachments/{attachmentId}/download"},{"label":"Create Profile Note","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-updates/protectpostkycprofilenotes","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-updates/protectpostkycprofilenotes","metadata":{"seo":{"title":"Create Profile Note","description":"Adds a note to a profile then Returns the details of the added note."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"protectPostKycProfileNotes","name":"Create Profile Note","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1notes/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Profile Note","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Adds a note to a profile then Returns the details of the added note."},{"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":"profileId","in":"path","schemaId":"schema_387","description":"Id of a profile.","required":true,"example":"9a7ae0c8-f473-4ab6-8dbb-03fc061630cc"}],"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1notes/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PostKYCProfileNotesRequest"}},"schemaId":"components/schemas/PostKYCProfileNotesRequest","pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1notes/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/compliance/kyc-protect/profiles/{profileId}/notes","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"example":"9a7ae0c8-f473-4ab6-8dbb-03fc061630cc","schemaId":"schema_387"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PostKYCProfileNotesRequest"}},"responseCodes":["201","400","401","403","404","409"],"pointer":"/compliance/kyc-protect/profiles/{profileId}/notes","href":"profile-updates/protectpostkycprofilenotes","openApiOperationId":"protectPostKycProfileNotes","summary":"Create Profile Note"},"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/PostKYCProfileNotesRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PostKYCProfileNotesRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PostKYCProfileNotes"}},"schemaId":"components/schemas/PostKYCProfileNotes"},{"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","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}],"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1notes/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/PostKYCProfileNotes","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PostKYCProfileNotes"}}},{"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":"409","schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/profile-updates/protectpostkycprofilenotes"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/profiles/{profileId}/notes"},{"label":"Return Profile Notes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-updates/protectgetkycprofilenotes","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-updates/protectgetkycprofilenotes","metadata":{"seo":{"title":"Return Profile Notes","description":"Returns a list of profile notes for the given profile id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"protectGetKycProfileNotes","name":"Return Profile Notes","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1notes/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return Profile Notes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a list of profile notes for the given profile 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":"profileId","in":"path","schemaId":"schema_387","description":"Id of a profile.","required":true,"example":"9a7ae0c8-f473-4ab6-8dbb-03fc061630cc"}],"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1notes/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_398","description":"Starting page number."},{"name":"pageSize","in":"query","schemaId":"schema_388","description":"Specifies the number of items to be displayed per page. Allowed values are between 1 and 100."},{"name":"searchTerm","in":"query","schemaId":"schema_387","description":"Filters the note list by notes with body containing the provided string"},{"name":"isArchived","in":"query","schemaId":"schema_392","description":"Get archived notes based on this flag. Allowed values are true, false or null"}],"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1notes/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/compliance/kyc-protect/profiles/{profileId}/notes","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"example":"9a7ae0c8-f473-4ab6-8dbb-03fc061630cc","schemaId":"schema_387"}],"query":[{"name":"page","in":"query","schemaId":"schema_398"},{"name":"pageSize","in":"query","schemaId":"schema_388"},{"name":"searchTerm","in":"query","schemaId":"schema_387"},{"name":"isArchived","in":"query","required":false,"schemaId":"schema_392"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/compliance/kyc-protect/profiles/{profileId}/notes","href":"profile-updates/protectgetkycprofilenotes","openApiOperationId":"protectGetKycProfileNotes","summary":"Return Profile Notes"},"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/GetKYCProtectProfileIdNotesResponse"}},"schemaId":"components/schemas/GetKYCProtectProfileIdNotesResponse"},{"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","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1notes/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetKYCProtectProfileIdNotesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetKYCProtectProfileIdNotesResponse"}}},{"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":"/profile-updates/protectgetkycprofilenotes"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/profiles/{profileId}/notes"},{"label":"Return Profile Notes By Note Id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-updates/protectgetkycprofilenotesbynoteid","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-updates/protectgetkycprofilenotesbynoteid","metadata":{"seo":{"title":"Return Profile Notes By Note Id","description":"Returns a profile note based on profile id and note id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"protectGetKycProfileNotesByNoteId","name":"Return Profile Notes By Note Id","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1notes~1{noteId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return Profile Notes By Note Id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a profile note based on profile id and note 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":"profileId","in":"path","schemaId":"schema_387","description":"Id of a profile.","required":true,"example":"9a7ae0c8-f473-4ab6-8dbb-03fc061630cc"},{"name":"noteId","in":"path","schemaId":"schema_387","description":"Id of a note.","required":true,"example":"047ae398-7639-40af-911e-cc214cf3045c"}],"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1notes~1{noteId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/compliance/kyc-protect/profiles/{profileId}/notes/{noteId}","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"example":"9a7ae0c8-f473-4ab6-8dbb-03fc061630cc","schemaId":"schema_387"},{"name":"noteId","in":"path","required":true,"example":"047ae398-7639-40af-911e-cc214cf3045c","schemaId":"schema_387"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/compliance/kyc-protect/profiles/{profileId}/notes/{noteId}","href":"profile-updates/protectgetkycprofilenotesbynoteid","openApiOperationId":"protectGetKycProfileNotesByNoteId","summary":"Return Profile Notes By Note 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/GetKYCProtectProfileIdNoteIdResponse"}},"schemaId":"components/schemas/GetKYCProtectProfileIdNoteIdResponse"},{"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","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1notes~1{noteId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetKYCProtectProfileIdNoteIdResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetKYCProtectProfileIdNoteIdResponse"}}},{"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":"/profile-updates/protectgetkycprofilenotesbynoteid"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/profiles/{profileId}/notes/{noteId}"},{"label":"Update Profile Note By Note Id","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-updates/protectupdatekycprofilenotesbynoteid","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-updates/protectupdatekycprofilenotesbynoteid","metadata":{"seo":{"title":"Update Profile Note By Note Id","description":"Updates a profile note based on profile id and note id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"protectUpdateKycProfileNotesByNoteId","name":"Update Profile Note By Note Id","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1notes~1{noteId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Profile Note By Note Id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates a profile note based on profile id and note 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":"profileId","in":"path","schemaId":"schema_387","description":"Id of a profile.","required":true,"example":"9a7ae0c8-f473-4ab6-8dbb-03fc061630cc"},{"name":"noteId","in":"path","schemaId":"schema_387","description":"Id of a note.","required":true,"example":"047ae398-7639-40af-911e-cc214cf3045c"}],"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1notes~1{noteId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PutKYCProfileNotesByNoteIdRequest"}},"schemaId":"components/schemas/PutKYCProfileNotesByNoteIdRequest","pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1notes~1{noteId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/compliance/kyc-protect/profiles/{profileId}/notes/{noteId}","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"example":"9a7ae0c8-f473-4ab6-8dbb-03fc061630cc","schemaId":"schema_387"},{"name":"noteId","in":"path","required":true,"example":"047ae398-7639-40af-911e-cc214cf3045c","schemaId":"schema_387"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PutKYCProfileNotesByNoteIdRequest"}},"responseCodes":["200","400","401","403","404","409"],"pointer":"/compliance/kyc-protect/profiles/{profileId}/notes/{noteId}","href":"profile-updates/protectupdatekycprofilenotesbynoteid","openApiOperationId":"protectUpdateKycProfileNotesByNoteId","summary":"Update Profile Note By Note 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"}],"schemaId":"components/schemas/PutKYCProfileNotesByNoteIdRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PutKYCProfileNotesByNoteIdRequest"}},"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/PutKYCProfileNotesByNoteId"}},"schemaId":"components/schemas/PutKYCProfileNotesByNoteId"},{"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","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}],"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1notes~1{noteId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PutKYCProfileNotesByNoteId","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PutKYCProfileNotesByNoteId"}}},{"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":"409","schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/profile-updates/protectupdatekycprofilenotesbynoteid"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/profiles/{profileId}/notes/{noteId}"},{"label":"Delete Profile Note By Note Id","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-updates/protectdeletekycprofilenotesbynoteid","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-updates/protectdeletekycprofilenotesbynoteid","metadata":{"seo":{"title":"Delete Profile Note By Note Id","description":"Deletes a profile note based on profile id and note id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"protectDeleteKycProfileNotesByNoteId","name":"Delete Profile Note By Note Id","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1notes~1{noteId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Profile Note By Note Id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a profile note based on profile id and note 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":"profileId","in":"path","schemaId":"schema_387","description":"Id of a profile.","required":true,"example":"9a7ae0c8-f473-4ab6-8dbb-03fc061630cc"},{"name":"noteId","in":"path","schemaId":"schema_387","description":"Id of a note.","required":true,"example":"047ae398-7639-40af-911e-cc214cf3045c"}],"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1notes~1{noteId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/compliance/kyc-protect/profiles/{profileId}/notes/{noteId}","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"example":"9a7ae0c8-f473-4ab6-8dbb-03fc061630cc","schemaId":"schema_387"},{"name":"noteId","in":"path","required":true,"example":"047ae398-7639-40af-911e-cc214cf3045c","schemaId":"schema_387"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","400","401","403","404"],"pointer":"/compliance/kyc-protect/profiles/{profileId}/notes/{noteId}","href":"profile-updates/protectdeletekycprofilenotesbynoteid","openApiOperationId":"protectDeleteKycProfileNotesByNoteId","summary":"Delete Profile Note By Note 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":"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","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1compliance~1kyc-protect~1profiles~1{profileId}~1notes~1{noteId}/delete/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":"/profile-updates/protectdeletekycprofilenotesbynoteid"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/profiles/{profileId}/notes/{noteId}"}],"content":{"contentType":"group","meta":{"name":"Profile Updates"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Profile Updates","showPageActions":true},{"nodeType":"markdoc","content":"Endpoints to update existing profiles with new information, such as addresses, notes, or attachments."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/compliance/kyc-protect/profiles/{profileId}","summary":"Update Profile By Profile Id","prefix":{"name":"put","color":"put"},"badges":[],"link":"/profile-updates/protectupdateskycprofilebyid","deprecated":false},{"title":"/compliance/kyc-protect/profiles/{profileId}/attachments","summary":"Add An Attachment To The Given Profile","prefix":{"name":"post","color":"post"},"badges":[],"link":"/profile-updates/kycprotectaddanattachmenttothegivenprofile","deprecated":false},{"title":"/compliance/kyc-protect/profiles/{profileId}/attachments","summary":"Return List Of Attachments On The Given Profile","prefix":{"name":"get","color":"get"},"badges":[],"link":"/profile-updates/kycprotectgetlistofattachmentsonthegivenprofile","deprecated":false},{"title":"/compliance/kyc-protect/profiles/{profileId}/attachments/{attachmentId}","summary":"Return A Profile Attachment By Profile And Attachment Id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/profile-updates/protectgetkycprofileattachmentbyprofileidandattachmentid","deprecated":false},{"title":"/compliance/kyc-protect/profiles/{profileId}/attachments/{attachmentId}","summary":"Update Profile Attachment By Profile And Attachment Id","prefix":{"name":"put","color":"put"},"badges":[],"link":"/profile-updates/protectputkycprofileattachmentbyprofileidandattachmentid","deprecated":false},{"title":"/compliance/kyc-protect/profiles/{profileId}/attachments/{attachmentId}","summary":"Delete Attachment By Profile And Attachment Id","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/profile-updates/protectdeletekycprofileattachmentbyprofileidandattachmentid","deprecated":false},{"title":"/compliance/kyc-protect/profiles/{profileId}/attachments/{attachmentId}/download","summary":"Download Profile Attachment By Profile And Attachment Id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/profile-updates/protectdownloadkycprofileattachmentbyprofileidandattachmentid","deprecated":false},{"title":"/compliance/kyc-protect/profiles/{profileId}/notes","summary":"Create Profile Note","prefix":{"name":"post","color":"post"},"badges":[],"link":"/profile-updates/protectpostkycprofilenotes","deprecated":false},{"title":"/compliance/kyc-protect/profiles/{profileId}/notes","summary":"Return Profile Notes","prefix":{"name":"get","color":"get"},"badges":[],"link":"/profile-updates/protectgetkycprofilenotes","deprecated":false},{"title":"/compliance/kyc-protect/profiles/{profileId}/notes/{noteId}","summary":"Return Profile Notes By Note Id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/profile-updates/protectgetkycprofilenotesbynoteid","deprecated":false},{"title":"/compliance/kyc-protect/profiles/{profileId}/notes/{noteId}","summary":"Update Profile Note By Note Id","prefix":{"name":"put","color":"put"},"badges":[],"link":"/profile-updates/protectupdatekycprofilenotesbynoteid","deprecated":false},{"title":"/compliance/kyc-protect/profiles/{profileId}/notes/{noteId}","summary":"Delete Profile Note By Note Id","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/profile-updates/protectdeletekycprofilenotesbynoteid","deprecated":false}]}]}]}]}},{"type":"group","label":"Reporting","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/reporting","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/reporting","items":[{"label":"Create AML / Audit Report","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/reporting/compliancepostkycreports","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/reporting/compliancepostkycreports","metadata":{"seo":{"title":"Create AML / Audit Report","description":"Uses the user-provided information to create a compliance report.  The criteria property in the request body must be populated using the fields returned by  the GET /criteria/{type} endpoint. Ensure you first retrieve the criteria for the desired report type using the GET /criteria/{type}  endpoint before making this request."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"compliancePostKycReports","name":"Create AML / Audit Report","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1reports/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create AML / Audit 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":"Uses the user-provided information to create a compliance report. "},"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":" The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"criteria"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property in the request body must be populated using the fields returned by  the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /criteria/{type}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"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":" Ensure you first retrieve the criteria for the desired report type using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /criteria/{type}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"  endpoint before making this 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":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PostKycProtectReportsRequest"}},"schemaId":"components/schemas/PostKycProtectReportsRequest","pointer":"/paths/~1compliance~1kyc-protect~1reports/post/requestBody","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request body containing the report type, file name, and criteria details for creating a compliance report."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"criteria"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field must adhere to the schema provided by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /criteria/{type}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/compliance/kyc-protect/reports","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/PostKycProtectReportsRequest"}},"responseCodes":["202","400","401","403","409","502"],"pointer":"/compliance/kyc-protect/reports","href":"reporting/compliancepostkycreports","openApiOperationId":"compliancePostKycReports","summary":"Create AML / Audit 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"}],"schemaId":"components/schemas/PostKycProtectReportsRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PostKycProtectReportsRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PostKycProtectReportResponse"}},"schemaId":"components/schemas/PostKycProtectReportResponse"},{"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":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"},{"code":"502","description":"Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}],"pointer":"/paths/~1compliance~1kyc-protect~1reports/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"components/schemas/PostKycProtectReportResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PostKycProtectReportResponse"}}},{"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":"409","schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}}},{"code":"502","schemaId":"components/schemas/ConnectErrorResponsesBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/reporting/compliancepostkycreports"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/reports"},{"label":"Return Report By Type","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/reporting/compliancegetkycreports","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/reporting/compliancegetkycreports","metadata":{"seo":{"title":"Return Report By Type","description":"Retrieves a list of compliance reports previously created, including their current status. Each report includes details such as the report type, creation date, status, and the criteria used to generate it.  The criteria field reflects the filters and parameters applied during report creation, which depend on the report type  (e.g., amlAlert or audit). Use this endpoint to monitor the status of your reports, view historical reports, and manage expiration timelines.  For generating new reports, refer to the POST /compliance/kyc-protect/reports endpoint."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"complianceGetKycReports","name":"Return Report By Type","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1reports/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return Report By Type","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 list of compliance reports previously created, including their current status."},"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":" Each report includes details such as the report type, creation date, status, and the criteria used to generate it.  The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"criteria"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field reflects the filters and parameters applied during report creation, which depend on the report type  (e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amlAlert"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"audit"},"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":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Use this endpoint to monitor the status of your reports, view historical reports, and manage expiration timelines.  For generating new reports, refer to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /compliance/kyc-protect/reports"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"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_388","description":"Starting page number.","required":true},{"name":"pageSize","in":"query","schemaId":"schema_471","description":"Specifies the number of items to be displayed per page. Allowed values are between 1 and 100.","required":true},{"name":"reportType","in":"query","schemaId":"schema_493","description":"Acceptable value is either 'AmlAlert', 'Audit', 'Profile', 'AmlScreen', 'MonitorSearch'. ","required":true},{"name":"searchTerm","in":"query","schemaId":"schema_387","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters the monitor reports by search_term."},"children":[]}]}]}]}],"pointer":"/paths/~1compliance~1kyc-protect~1reports/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/compliance/kyc-protect/reports","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","required":true,"schemaId":"schema_388"},{"name":"pageSize","in":"query","required":true,"schemaId":"schema_471"},{"name":"reportType","in":"query","required":true,"schemaId":"schema_493"},{"name":"searchTerm","in":"query","schemaId":"schema_387"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","409","502"],"pointer":"/compliance/kyc-protect/reports","href":"reporting/compliancegetkycreports","openApiOperationId":"complianceGetKycReports","summary":"Return Report By Type"},"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/GetKycProtectReportsResponse"}},"schemaId":"components/schemas/GetKycProtectReportsResponse"},{"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":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"},{"code":"502","description":"Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}],"pointer":"/paths/~1compliance~1kyc-protect~1reports/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetKycProtectReportsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetKycProtectReportsResponse"}}},{"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":"409","schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}}},{"code":"502","schemaId":"components/schemas/ConnectErrorResponsesBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/reporting/compliancegetkycreports"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/reports"},{"label":"Retrieve a Single Report by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/reporting/compliancegetkycreportsbyreportid","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/reporting/compliancegetkycreportsbyreportid","metadata":{"seo":{"title":"Retrieve a Single Report by ID","description":"Fetches the details of a single compliance report identified by its unique reportId.  This endpoint allows users to retrieve the full metadata and status of a specific report,  including its creation details, criteria, and expiration timeline.  Use this endpoint to inspect or verify the information of an existing report,  or to confirm its current status (e.g., inProgress, completed, failed).  Ensure that the reportId provided corresponds to an existing report in the system."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"complianceGetKycReportsByReportId","name":"Retrieve a Single Report by ID","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1reports~1{reportId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a Single Report by ID","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":"Fetches the details of a single compliance report identified by its unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reportId"},"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":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This endpoint allows users to retrieve the full metadata and status of a specific report,  including its creation details, criteria, and expiration timeline. "},"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":" Use this endpoint to inspect or verify the information of an existing report,  or to confirm its current status (e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inProgress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"completed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"failed"},"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":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Ensure that the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reportId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" provided corresponds to an existing report in the system."},"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":"reportId","in":"path","schemaId":"schema_451","description":"The unique identifier of the report to be retrieved. Must be a valid UUID that corresponds  to an existing report in the system.\n","required":true}],"pointer":"/paths/~1compliance~1kyc-protect~1reports~1{reportId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/compliance/kyc-protect/reports/{reportId}","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"reportId","in":"path","required":true,"schemaId":"schema_451"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","409","502"],"pointer":"/compliance/kyc-protect/reports/{reportId}","href":"reporting/compliancegetkycreportsbyreportid","openApiOperationId":"complianceGetKycReportsByReportId","summary":"Retrieve a Single Report 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","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetKycProtectReportsResponseByReportId"}},"schemaId":"components/schemas/GetKycProtectReportsResponseByReportId"},{"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":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"},{"code":"502","description":"Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}],"pointer":"/paths/~1compliance~1kyc-protect~1reports~1{reportId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetKycProtectReportsResponseByReportId","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetKycProtectReportsResponseByReportId"}}},{"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":"409","schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}}},{"code":"502","schemaId":"components/schemas/ConnectErrorResponsesBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/reporting/compliancegetkycreportsbyreportid"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/reports/{reportId}"},{"label":"Download a Report by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/reporting/compliancegetdownloadkycreportsbyreportid","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/reporting/compliancegetdownloadkycreportsbyreportid","metadata":{"seo":{"title":"Download a Report by ID","description":"Retrieves the download information for a specific compliance report identified by its unique reportId.  This endpoint provides the URL to download the report file, along with metadata such as the file name and  the expiration time for the download link.  Use this endpoint after generating a report to access the final output. Ensure the reportId corresponds to  a valid and completed report in the system."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"complianceGetDownloadKycReportsByReportId","name":"Download a Report by ID","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1reports~1{reportId}~1download/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download a Report by ID","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 the download information for a specific compliance report identified by its unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reportId"},"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":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This endpoint provides the URL to download the report file, along with metadata such as the file name and  the expiration time for the download link. "},"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":" Use this endpoint after generating a report to access the final output. Ensure the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reportId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" corresponds to  a valid and completed report in the system."},"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":"reportId","in":"path","schemaId":"schema_451","description":"The unique identifier of the report to be downloaded. Must be a valid UUID that corresponds  to an existing and completed report in the system.\n","required":true}],"pointer":"/paths/~1compliance~1kyc-protect~1reports~1{reportId}~1download/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/compliance/kyc-protect/reports/{reportId}/download","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"reportId","in":"path","required":true,"schemaId":"schema_451"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","409","502"],"pointer":"/compliance/kyc-protect/reports/{reportId}/download","href":"reporting/compliancegetdownloadkycreportsbyreportid","openApiOperationId":"complianceGetDownloadKycReportsByReportId","summary":"Download a Report 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","description":"Success. Returns the download URL, file name, and expiration timestamp for the specified report.\n","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_494"}},"schemaId":"schema_494"},{"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":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"},{"code":"502","description":"Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}],"pointer":"/paths/~1compliance~1kyc-protect~1reports~1{reportId}~1download/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_494","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_494"}}},{"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":"409","schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}}},{"code":"502","schemaId":"components/schemas/ConnectErrorResponsesBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/reporting/compliancegetdownloadkycreportsbyreportid"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/reports/{reportId}/download"},{"label":"Retrieve Report Criteria","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/reporting/compliancegetkyccriteriabytype","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/reporting/compliancegetkyccriteriabytype","metadata":{"seo":{"title":"Retrieve Report Criteria","description":"Fetches the available criteria for a specified report type. This endpoint is a prerequisite for creating a report and provides the valid fields that can populate the criteria property in the POST /reports request. Use this to retrieve a list of valid fields for the report type before proceeding with report creation."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"complianceGetKycCriteriabyType","name":"Retrieve Report Criteria","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1reports~1criteria~1{type}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve Report Criteria","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":"Fetches the available criteria for a specified report type."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This endpoint is a prerequisite for creating a report and provides the valid fields that can populate the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"criteria"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /reports"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 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":" Use this to retrieve a list of valid fields for the report type before proceeding with report creation."},"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":"type","in":"path","schemaId":"schema_493","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of report for which criteria are requested.  Supported values:"},"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":"code","inline":true,"attributes":{"content":"amlAlert"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Criteria for Anti-Money Laundering alerts."},"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":"audit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Criteria for audit-related reports."},"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":"profile"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Criteria for profile-based reports."},"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":"amlScreen"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Criteria for AML screening reports."},"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":"monitorSearch"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Criteria for monitoring search reports."},"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":[]}]}]}],"required":true}],"pointer":"/paths/~1compliance~1kyc-protect~1reports~1criteria~1{type}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/compliance/kyc-protect/reports/criteria/{type}","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"type","in":"path","required":true,"schemaId":"schema_493"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","409","502"],"pointer":"/compliance/kyc-protect/reports/criteria/{type}","href":"reporting/compliancegetkyccriteriabytype","openApiOperationId":"complianceGetKycCriteriabyType","summary":"Retrieve Report Criteria"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_495","exampleIds":["paths/~1compliance~1kyc-protect~1reports~1criteria~1{type}/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_495","exampleIds":["paths/~1compliance~1kyc-protect~1reports~1criteria~1{type}/get/responses/200/content/application~1json/example"]},{"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":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"},{"code":"502","description":"Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}],"pointer":"/paths/~1compliance~1kyc-protect~1reports~1criteria~1{type}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_495","exampleIds":["paths/~1compliance~1kyc-protect~1reports~1criteria~1{type}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_495","exampleIds":["paths/~1compliance~1kyc-protect~1reports~1criteria~1{type}/get/responses/200/content/application~1json/example"]}}},{"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":"409","schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceConflictResponse"}}},{"code":"502","schemaId":"components/schemas/ConnectErrorResponsesBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/reporting/compliancegetkyccriteriabytype"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/reports/criteria/{type}"}],"content":{"contentType":"group","meta":{"name":"Reporting"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reporting","showPageActions":true},{"nodeType":"markdoc","content":"Endpoints to generate and retrieve reports, including compliance reports and risk assessments."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/compliance/kyc-protect/reports","summary":"Create AML / Audit Report","prefix":{"name":"post","color":"post"},"badges":[],"link":"/reporting/compliancepostkycreports","deprecated":false},{"title":"/compliance/kyc-protect/reports","summary":"Return Report By Type","prefix":{"name":"get","color":"get"},"badges":[],"link":"/reporting/compliancegetkycreports","deprecated":false},{"title":"/compliance/kyc-protect/reports/{reportId}","summary":"Retrieve a Single Report by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/reporting/compliancegetkycreportsbyreportid","deprecated":false},{"title":"/compliance/kyc-protect/reports/{reportId}/download","summary":"Download a Report by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/reporting/compliancegetdownloadkycreportsbyreportid","deprecated":false},{"title":"/compliance/kyc-protect/reports/criteria/{type}","summary":"Retrieve Report Criteria","prefix":{"name":"get","color":"get"},"badges":[],"link":"/reporting/compliancegetkyccriteriabytype","deprecated":false}]}]}]}]}},{"type":"group","label":"Searches","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/searches","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/searches","items":[{"label":"Return Compliance Kyc Protect Searches Results","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/searches/compliancekycprotectgetsearches","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/searches/compliancekycprotectgetsearches","metadata":{"seo":{"title":"Return Compliance Kyc Protect Searches Results","description":"Returns a list of all performed searches, including details such as ID, name, type, risk rating, datasets, creation and assignment information, and PEP tier. Supports filters such as search type, keyword, dataset, threshold, PEP tier, and scheduled status."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"complianceKYCProtectGetSearches","name":"Return Compliance Kyc Protect Searches Results","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1searches/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return Compliance Kyc Protect Searches Results","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a list of all performed searches, including details such as ID, name, type, risk rating, datasets, creation and assignment information, and PEP tier. Supports filters such as search type, keyword, dataset, threshold, PEP tier, and scheduled status."},{"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":"IsScheduled","in":"query","schemaId":"schema_428","description":"Filter searches by scheduled status. Defaults to false if not specified."},{"name":"SearchType","in":"query","schemaId":"schema_450","description":"Filter searches by type (e.g., Individual, Business)"},{"name":"SearchTerm","in":"query","schemaId":"schema_387","description":"Filter searches by search term"},{"name":"Datasets","in":"query","schemaId":"schema_449","description":"Filter searches by specific datasets"},{"name":"Thresholds","in":"query","schemaId":"schema_496","description":"Filter searches by specific thresholds"},{"name":"PepTiers","in":"query","schemaId":"schema_497","description":"Filter searches by PEP tiers"},{"name":"page","in":"query","schemaId":"schema_471","description":"The page number to fetch. Should be a positive integer.","required":true},{"name":"pageSize","in":"query","schemaId":"schema_471","description":"Specifies the number of items to be displayed per page. Allowed values are between 1 and 100.","required":true}],"pointer":"/paths/~1compliance~1kyc-protect~1searches/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/compliance/kyc-protect/searches","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[],"query":[{"name":"IsScheduled","in":"query","schemaId":"schema_428"},{"name":"SearchType","in":"query","schemaId":"schema_450"},{"name":"SearchTerm","in":"query","schemaId":"schema_387"},{"name":"Datasets","in":"query","schemaId":"schema_449"},{"name":"Thresholds","in":"query","schemaId":"schema_496"},{"name":"PepTiers","in":"query","schemaId":"schema_497"},{"name":"page","in":"query","required":true,"schemaId":"schema_471"},{"name":"pageSize","in":"query","required":true,"schemaId":"schema_471"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403"],"pointer":"/compliance/kyc-protect/searches","href":"searches/compliancekycprotectgetsearches","openApiOperationId":"complianceKYCProtectGetSearches","summary":"Return Compliance Kyc Protect Searches Results"},"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":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KycProtectGetIndividualSearchResponse"}},"schemaId":"components/schemas/KycProtectGetIndividualSearchResponse"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"},{"code":"401","description":"Unauthorized","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/~1compliance~1kyc-protect~1searches/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/KycProtectGetIndividualSearchResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KycProtectGetIndividualSearchResponse"}}},{"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":"/searches/compliancekycprotectgetsearches"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/searches"},{"label":"Download A CSV Report Of Monitored Searches","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/searches/compliancekycprotectgetsearchesmonitoreddownload","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/searches/compliancekycprotectgetsearchesmonitoreddownload","metadata":{"seo":{"title":"Download A CSV Report Of Monitored Searches","description":"This endpoint allows downloading monitored searches filtered by various criteria as a CSV file.A maximum of 1000 records can be downloaded at once. If more than 1000 records match the criteria, If no searches are found, a 204 No Content response is returned. A 409 Conflict response is returned."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"complianceKYCProtectGetSearchesMonitoredDownload","name":"Download A CSV Report Of Monitored Searches","isWebhook":false,"pointer":"/paths/~1compliance~1kyc-protect~1searches~1monitored~1download/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download A CSV Report Of Monitored Searches","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This endpoint allows downloading monitored searches filtered by various criteria as a CSV file.A maximum of 1000 records can be downloaded at once. If more than 1000 records match the criteria, If no searches are found, a 204 No Content response is returned. A 409 Conflict response is returned."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API requires authentication for access to protected endpoints. Authentication is performed by providing a valid JWT token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"searchType","in":"query","schemaId":"schema_450","description":"Gets or sets the search type (e.g., \"business\", \"individual\")."},{"name":"searchTerm","in":"query","schemaId":"schema_387","description":"Gets or sets the search term."},{"name":"isScheduled","in":"query","schemaId":"schema_428","description":"Gets or sets a value indicating whether the search is scheduled. Default is true for monitored searches."},{"name":"datasets","in":"query","schemaId":"schema_449","description":"Gets or sets the datasets to filter by."},{"name":"thresholds","in":"query","schemaId":"schema_496","description":"Gets or sets the thresholds for the search results (e.g., 75, 80, 85, 90, 95, 100)."},{"name":"pepTiers","in":"query","schemaId":"schema_497","description":"Gets or sets the PEP tiers to filter by."}],"pointer":"/paths/~1compliance~1kyc-protect~1searches~1monitored~1download/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/compliance/kyc-protect/searches/monitored/download","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[],"query":[{"name":"searchType","in":"query","schemaId":"schema_450"},{"name":"searchTerm","in":"query","schemaId":"schema_387"},{"name":"isScheduled","in":"query","schemaId":"schema_428"},{"name":"datasets","in":"query","schemaId":"schema_449"},{"name":"thresholds","in":"query","schemaId":"schema_496"},{"name":"pepTiers","in":"query","schemaId":"schema_497"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403"],"pointer":"/compliance/kyc-protect/searches/monitored/download","href":"searches/compliancekycprotectgetsearchesmonitoreddownload","openApiOperationId":"complianceKYCProtectGetSearchesMonitoredDownload","summary":"Download A CSV Report Of Monitored Searches"},"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":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KycProtectGetMonitoredSearchesDownloadResponse"}},"schemaId":"components/schemas/KycProtectGetMonitoredSearchesDownloadResponse"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"},{"code":"401","description":"Unauthorized","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/~1compliance~1kyc-protect~1searches~1monitored~1download/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/KycProtectGetMonitoredSearchesDownloadResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KycProtectGetMonitoredSearchesDownloadResponse"}}},{"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":"/searches/compliancekycprotectgetsearchesmonitoreddownload"}],"panels":[]}]},"httpPath":"/compliance/kyc-protect/searches/monitored/download"}],"content":{"contentType":"group","meta":{"name":"Searches"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Searches","showPageActions":true},{"nodeType":"markdoc","content":"Endpoint to review performed searches for businesses or individuals, including retrieving search results and downloading reports."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/compliance/kyc-protect/searches","summary":"Return Compliance Kyc Protect Searches Results","prefix":{"name":"get","color":"get"},"badges":[],"link":"/searches/compliancekycprotectgetsearches","deprecated":false},{"title":"/compliance/kyc-protect/searches/monitored/download","summary":"Download A CSV Report Of Monitored Searches","prefix":{"name":"get","color":"get"},"badges":[],"link":"/searches/compliancekycprotectgetsearchesmonitoreddownload","deprecated":false}]}]}]}]}},{"type":"separator","label":"Local Solutions","content":null},{"type":"group","label":"GB Bank Match","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/gb-bank-match","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/gb-bank-match","items":[{"label":"Bank Match","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/gb-bank-match/bankmatch","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/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_498","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_387","description":"The connectId or safeNumber of the company to check against.","required":true,"example":"GB-0-X9999999"},{"name":"sortCode","in":"query","schemaId":"schema_387","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_387","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_387","description":"IBAN to check","example":"GB55TEST08999966374957"},{"name":"vatNumber","in":"query","schemaId":"schema_387","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_498"},{"name":"companyId","in":"query","required":true,"example":"GB-0-X9999999","schemaId":"schema_387"},{"name":"sortCode","in":"query","example":"089997","schemaId":"schema_387"},{"name":"accountNumber","in":"query","example":66374958,"schemaId":"schema_387"},{"name":"iban","in":"query","example":"GB55TEST08999966374957","schemaId":"schema_387"},{"name":"vatNumber","in":"query","schemaId":"schema_387"}],"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 Bank Verification","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/gb-bank-verification","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/gb-bank-verification","items":[{"label":"Request Search History","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/gb-bank-verification/bankverificationgethistorylist","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/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_428","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_387","description":"Name of the customer returned by the supplier."},{"name":"matchResult","in":"query","schemaId":"schema_387","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_387","description":"Start date for filtering the results list by."},{"name":"dateTo","in":"query","schemaId":"schema_387","description":"End date for filtering the results list by."},{"name":"accountType","in":"query","schemaId":"schema_387","description":"Type of account queried with the the supplier. Values are 'Business' and 'Personal'."},{"name":"customerReference","in":"query","schemaId":"schema_387","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_428"},{"name":"customerName","in":"query","schemaId":"schema_387"},{"name":"matchResult","in":"query","schemaId":"schema_387"},{"name":"dateFrom","in":"query","schemaId":"schema_387"},{"name":"dateTo","in":"query","schemaId":"schema_387"},{"name":"accountType","in":"query","schemaId":"schema_387"},{"name":"customerReference","in":"query","schemaId":"schema_387"}],"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_499"}},"schemaId":"schema_499"},{"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_499","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_499"}}},{"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/connect-api-full/connectapi/gb-bank-verification/bankverificationgethistorybyid","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/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_387","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_387"}],"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/connect-api-full/connectapi/gb-bank-verification/bankverificationupdatehistory","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/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_387","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_387"}],"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"},{"label":"Single Request","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/gb-bank-verification/bankverificationsearch","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/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":"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/connect-api-full/connectapi/gb-bank-verification/sortcodecheck","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/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_387","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_387"}],"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_500"}},"schemaId":"schema_500"},{"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_500","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_500"}}},{"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":"Validate Bank Verification Request","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/gb-bank-verification/bankverificationvalidate","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/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_387","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_501"}},"schemaId":"schema_501","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_387"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_501"}},"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_501","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_501"}},"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_502"}},"schemaId":"schema_502"},{"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_502","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_502"}}},{"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}"}],"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/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},{"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/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/validate/{id}","summary":"Validate Bank Verification Request","prefix":{"name":"post","color":"post"},"badges":[],"link":"/gb-bank-verification/bankverificationvalidate","deprecated":false}]}]}]}]}},{"type":"group","label":"GB Land Registry","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/gb-land-registry","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/gb-land-registry","items":[{"label":"GB Land Registry","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/gb-land-registry/gblandregistry","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/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_387","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_423","description":"language the report is requested in."},{"name":"page","in":"query","schemaId":"schema_398","description":"Starting page number."},{"name":"pageSize","in":"query","schemaId":"schema_388","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_387"}],"query":[{"name":"language","in":"query","schemaId":"schema_423"},{"name":"page","in":"query","schemaId":"schema_398"},{"name":"pageSize","in":"query","schemaId":"schema_388"}],"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":"GB Finance Agreements","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/gb-finance-agreements","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/gb-finance-agreements","items":[{"label":"Request Finance Agreements","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/gb-finance-agreements/financeagreements","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/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_387","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_392"}],"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_387"}],"query":[{"name":"excludeCutOffDate","in":"query","required":false,"schemaId":"schema_392"}],"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_503"}},"schemaId":"schema_503"},{"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_503","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_503"}}},{"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":"FR Bank Match","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/fr-bank-match","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/fr-bank-match","items":[{"label":"Bank Match","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/fr-bank-match/frbankmatch","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/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_387","description":"registrationId of company","required":true},{"name":"countryCode","in":"query","schemaId":"schema_387","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_387","description":"Bank Account Number for countries where IBAN format doesn't support"},{"name":"bankCountry","in":"query","schemaId":"schema_387","description":"Bank Country always expected in ISO-2-alpha code"},{"name":"iban","in":"query","schemaId":"schema_387","description":"Bank Account details in IBAN format","required":true},{"name":"bic","in":"query","schemaId":"schema_387","description":"Business/Bank Identifier Code to identify the bank/branch holding the account along with BBAN"},{"name":"routingCode","in":"query","schemaId":"schema_387","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_387"},{"name":"countryCode","in":"query","required":true,"schemaId":"schema_387"},{"name":"bban","in":"query","schemaId":"schema_387"},{"name":"bankCountry","in":"query","schemaId":"schema_387"},{"name":"iban","in":"query","required":true,"schemaId":"schema_387"},{"name":"bic","in":"query","schemaId":"schema_387"},{"name":"routingCode","in":"query","schemaId":"schema_387"}],"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/connect-api-full/connectapi/fr-bank-match/frbankmatchstatus","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/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_387","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_387"}],"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":"group","label":"DE NonLtd Companies","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/de-nonltd-companies","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/de-nonltd-companies","items":[{"label":"DE Company Search (Non Ltd)","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/de-nonltd-companies/denonltdcompaniessearch","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/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_387","description":"The name of the company to search for.","required":true},{"name":"countryAreaCode","in":"query","schemaId":"schema_411","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_411","description":"The primary telephone number"},{"name":"areaCode","in":"query","schemaId":"schema_411","description":"The regional or city-specific area code ( e.g. \"\"030\"\" for Berlin )."},{"name":"zipPostCode","in":"query","schemaId":"schema_411","description":"A combination of ZIP and PO box information, if applicable."},{"name":"country","in":"query","schemaId":"schema_411","description":"The country of the address."},{"name":"zipCode","in":"query","schemaId":"schema_412","description":"The postal code associated with the address. This field is optional."},{"name":"postCode","in":"query","schemaId":"schema_411","description":"The post office box number, if applicable."},{"name":"street","in":"query","schemaId":"schema_410","description":"The street name and house number for the address. This field is optional."},{"name":"city","in":"query","schemaId":"schema_410","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_387"},{"name":"countryAreaCode","in":"query","schemaId":"schema_411"},{"name":"number","in":"query","schemaId":"schema_411"},{"name":"areaCode","in":"query","schemaId":"schema_411"},{"name":"zipPostCode","in":"query","schemaId":"schema_411"},{"name":"country","in":"query","schemaId":"schema_411"},{"name":"zipCode","in":"query","schemaId":"schema_412"},{"name":"postCode","in":"query","schemaId":"schema_411"},{"name":"street","in":"query","schemaId":"schema_410"},{"name":"city","in":"query","required":true,"schemaId":"schema_410"}],"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/connect-api-full/connectapi/de-nonltd-companies/denonltdcompaniesreport","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/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_451","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_387","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_451"}],"query":[{"name":"reason","in":"query","required":true,"schemaId":"schema_387"}],"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}"},{"label":"DE Company Search Criteria (Non Ltd)","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/de-nonltd-companies/denonltdcompaniessearchcriteria","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/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"}],"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","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},{"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}]}]}]}]}},{"type":"group","label":"NL KVK Extract","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/nl-kvk-extract","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/nl-kvk-extract","items":[{"label":"Return NL Extract","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/nl-kvk-extract/extractnlkvknumber","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/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_387","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_387"}],"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_387"}},"schemaId":"schema_387"},{"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_387","mediaTypes":["text/html"],"mediaTypeContent":{"text/html":{"schemaId":"schema_387"}}},{"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":"group","label":"US Search Support","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/us-search-support","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/us-search-support","items":[{"label":"Fresh Investigation Request","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/us-search-support/createfreshinvestigationforuscountry","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/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_504","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_504"}],"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}],"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}]}]}]}]}},{"type":"group","label":"Verify","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/verify","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/verify","items":[{"label":"Return Indicator Based On Company Identifier","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/verify/getcompanyinformation","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/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_505","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_506","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_505"}],"query":[{"name":"reasonForSearch","in":"query","required":true,"schemaId":"schema_506"}],"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":"Retrieve Individual Full Information","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/verify/getfullinformationbyid","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/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_507","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_387","description":"Additional free text for audit logging."},{"name":"reasonForSearch","in":"query","schemaId":"schema_506","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_507"}],"query":[{"name":"freeText","in":"query","schemaId":"schema_387"},{"name":"reasonForSearch","in":"query","required":true,"schemaId":"schema_506"}],"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"},{"label":"Retrieve Individual Summary Information","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/verify/getsummaryinformationbyid","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/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_507","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_387","description":"Additional free text for audit logging."},{"name":"reasonForSearch","in":"query","schemaId":"schema_506","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_507"}],"query":[{"name":"freeText","in":"query","schemaId":"schema_387"},{"name":"reasonForSearch","in":"query","required":true,"schemaId":"schema_506"}],"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":"Execute Individual Search","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/verify/getindividualdirectreport","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/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_387","description":"Title of the individual."},{"name":"firstName","in":"query","schemaId":"schema_387","description":"First name of the individual.","required":true},{"name":"middleName","in":"query","schemaId":"schema_387","description":"Middle name of the individual."},{"name":"lastName","in":"query","schemaId":"schema_387","description":"Last name of the individual.","required":true},{"name":"dateOfBirth","in":"query","schemaId":"schema_387","description":"Date of birth of the individual.","required":true},{"name":"houseNo","in":"query","schemaId":"schema_387","description":"House number of the address."},{"name":"buildingName","in":"query","schemaId":"schema_387","description":"Building name of the address."},{"name":"subBuilding","in":"query","schemaId":"schema_387","description":"Sub building of the address.."},{"name":"street","in":"query","schemaId":"schema_387","description":"Street of the address."},{"name":"city","in":"query","schemaId":"schema_387","description":"City of the address."},{"name":"province","in":"query","schemaId":"schema_387","description":"Province of the address."},{"name":"postCode","in":"query","schemaId":"schema_387","description":"Postal code of the address.","required":true},{"name":"address","in":"query","schemaId":"schema_387","description":"Full address.","required":true},{"name":"reasonForSearch","in":"query","schemaId":"schema_506","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_387"},{"name":"firstName","in":"query","required":true,"schemaId":"schema_387"},{"name":"middleName","in":"query","schemaId":"schema_387"},{"name":"lastName","in":"query","required":true,"schemaId":"schema_387"},{"name":"dateOfBirth","in":"query","required":true,"schemaId":"schema_387"},{"name":"houseNo","in":"query","schemaId":"schema_387"},{"name":"buildingName","in":"query","schemaId":"schema_387"},{"name":"subBuilding","in":"query","schemaId":"schema_387"},{"name":"street","in":"query","schemaId":"schema_387"},{"name":"city","in":"query","schemaId":"schema_387"},{"name":"province","in":"query","schemaId":"schema_387"},{"name":"postCode","in":"query","required":true,"schemaId":"schema_387"},{"name":"address","in":"query","required":true,"schemaId":"schema_387"},{"name":"reasonForSearch","in":"query","required":true,"schemaId":"schema_506"}],"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/connect-api-full/connectapi/verify/localsolutionsgbverifyindividualdirectreportpost","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/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"}],"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":"/localSolutions/GB/verify/company/{id}","summary":"Return Indicator Based On Company Identifier","prefix":{"name":"get","color":"get"},"badges":[],"link":"/verify/getcompanyinformation","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},{"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/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}]}]}]}]}},{"type":"separator","label":"Protect (Legacy)","content":null},{"type":"group","label":"Audit (Legacy)","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/audit-(legacy)","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/audit-(legacy)","items":[{"label":"Return Protect Audit Log","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/audit-(legacy)/retrieveprotectauditlog","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/audit-(legacy)/retrieveprotectauditlog","metadata":{"seo":{"title":"Return Protect Audit Log","description":"Returns logged interactions with Protect endpoints for audit purposes. Actions logged include creating an Investigation, Investigation Record and Schedule."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieveProtectAuditLog","name":"Return Protect Audit Log","isWebhook":false,"pointer":"/paths/~1protect~1audits/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return Protect Audit Log","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns logged interactions with Protect endpoints for audit purposes. Actions logged include creating an Investigation, Investigation Record and Schedule."},{"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_398","description":"Starting page number."},{"name":"pageSize","in":"query","schemaId":"schema_388","description":"Specifies the number of items to be displayed per page. Allowed values are between 1 and 100."},{"name":"type","in":"query","schemaId":"schema_508"},{"name":"newerThan","in":"query","schemaId":"schema_430"},{"name":"olderThan","in":"query","schemaId":"schema_430"},{"name":"profileId","in":"query","schemaId":"schema_509"},{"name":"order","in":"query","schemaId":"schema_411"}],"pointer":"/paths/~1protect~1audits/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/protect/audits","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_398"},{"name":"pageSize","in":"query","schemaId":"schema_388"},{"name":"type","in":"query","schemaId":"schema_508"},{"name":"newerThan","in":"query","schemaId":"schema_430"},{"name":"olderThan","in":"query","schemaId":"schema_430"},{"name":"profileId","in":"query","schemaId":"schema_509"},{"name":"order","in":"query","schemaId":"schema_411"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/protect/audits","href":"audit-(legacy)/retrieveprotectauditlog","openApiOperationId":"retrieveProtectAuditLog","summary":"Return Protect Audit Log"},"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_510"}},"schemaId":"schema_510"},{"code":"400","description":"Bad Request Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"},{"code":"401","description":"Invalid Token response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}},"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"},{"code":"403","description":"Access Forbidden Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}},"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"},{"code":"404","description":"404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1protect~1audits/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_510","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_510"}}},{"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":"/audit-(legacy)/retrieveprotectauditlog"}],"panels":[]}]},"httpPath":"/protect/audits"},{"label":"Export Audit Log File","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/audit-(legacy)/exportauditlogfile","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/audit-(legacy)/exportauditlogfile","metadata":{"seo":{"title":"Export Audit Log File","description":"Produces a collection a csv of Audit records."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"exportAuditLogFile","name":"Export Audit Log File","isWebhook":false,"pointer":"/paths/~1protect~1audits/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Export Audit Log File","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Produces a collection a csv of Audit records."},{"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/ConnectProtectAuditExportRequestDto"}},"schemaId":"components/schemas/ConnectProtectAuditExportRequestDto","pointer":"/paths/~1protect~1audits/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/protect/audits","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/ConnectProtectAuditExportRequestDto"}},"responseCodes":["200","400","401","403","404"],"pointer":"/protect/audits","href":"audit-(legacy)/exportauditlogfile","openApiOperationId":"exportAuditLogFile","summary":"Export Audit Log File"},"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/ConnectProtectAuditExportRequestDto","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ConnectProtectAuditExportRequestDto"}},"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/ConnectProtectAuditsExportResponseDto"}},"schemaId":"components/schemas/ConnectProtectAuditsExportResponseDto"},{"code":"400","description":"Bad Request Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"},{"code":"401","description":"Invalid Token response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}},"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"},{"code":"403","description":"Access Forbidden Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}},"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"},{"code":"404","description":"404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1protect~1audits/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConnectProtectAuditsExportResponseDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectProtectAuditsExportResponseDto"}}},{"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":"/audit-(legacy)/exportauditlogfile"}],"panels":[]}]},"httpPath":"/protect/audits"}],"content":{"contentType":"group","meta":{"name":"Audit (Legacy)"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Audit (Legacy)","showPageActions":true},{"nodeType":"markdoc","content":"Provides a log of all actions taken against endpoints to evidence any necessary that checks were carried out correctly."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/protect/audits","summary":"Return Protect Audit Log","prefix":{"name":"get","color":"get"},"badges":[],"link":"/audit-(legacy)/retrieveprotectauditlog","deprecated":false},{"title":"/protect/audits","summary":"Export Audit Log File","prefix":{"name":"post","color":"post"},"badges":[],"link":"/audit-(legacy)/exportauditlogfile","deprecated":false}]}]}]}]}},{"type":"group","label":"IDV (Legacy)","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/idv-(legacy)","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/idv-(legacy)","items":[{"label":"Return IDV Report","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/idv-(legacy)/returnsidvreport","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/idv-(legacy)/returnsidvreport","metadata":{"seo":{"title":"Return IDV Report","description":"Returns an IDV Report with the potential results and the sources they were matched against."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"returnsIdvReport","name":"Return IDV Report","isWebhook":false,"pointer":"/paths/~1protect~1idv~1file/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return IDV Report","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns an IDV Report with the potential results and the sources they were matched against."},{"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":"idvSearchId","in":"query","schemaId":"schema_509"}],"pointer":"/paths/~1protect~1idv~1file/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/protect/idv/file","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[],"query":[{"name":"idvSearchId","in":"query","schemaId":"schema_509"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/protect/idv/file","href":"idv-(legacy)/returnsidvreport","openApiOperationId":"returnsIdvReport","summary":"Return IDV 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","text/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_387"},"text/json":{"schemaId":"schema_387"}},"schemaId":"schema_387"},{"code":"404","mediaType":"text/plain","mediaTypes":["text/plain","application/json","text/json"],"mediaTypeContent":{"text/plain":{"schemaId":"components/schemas/ConnectProtectProblemDetails"},"application/json":{"schemaId":"components/schemas/ConnectProtectProblemDetails"},"text/json":{"schemaId":"components/schemas/ConnectProtectProblemDetails"}},"schemaId":"components/schemas/ConnectProtectProblemDetails"}],"pointer":"/paths/~1protect~1idv~1file/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_387","mediaTypes":["application/json","text/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_387"},"text/json":{"schemaId":"schema_387"}}},{"code":"404","schemaId":"components/schemas/ConnectProtectProblemDetails","mediaTypes":["text/plain","application/json","text/json"],"mediaTypeContent":{"text/plain":{"schemaId":"components/schemas/ConnectProtectProblemDetails"},"application/json":{"schemaId":"components/schemas/ConnectProtectProblemDetails"},"text/json":{"schemaId":"components/schemas/ConnectProtectProblemDetails"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/idv-(legacy)/returnsidvreport"}],"panels":[]}]},"httpPath":"/protect/idv/file"},{"label":"Execute IDV Search","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/idv-(legacy)/idvsearch","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/idv-(legacy)/idvsearch","metadata":{"seo":{"title":"Execute IDV Search","description":"Creates a search request for a GDC IDV search."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"idvSearch","name":"Execute IDV Search","isWebhook":false,"pointer":"/paths/~1protect~1idv~1gdc~1search/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute IDV Search","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a search request for a GDC IDV search."},{"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","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/IdvRequestDto"},"text/json":{"schemaId":"components/schemas/IdvRequestDto"},"application/*+json":{"schemaId":"components/schemas/IdvRequestDto"}},"schemaId":"components/schemas/IdvRequestDto","pointer":"/paths/~1protect~1idv~1gdc~1search/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/protect/idv/gdc/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/IdvRequestDto"},"text/json":{"schemaId":"components/schemas/IdvRequestDto"},"application/*+json":{"schemaId":"components/schemas/IdvRequestDto"}},"responseCodes":["200","400"],"pointer":"/protect/idv/gdc/search","href":"idv-(legacy)/idvsearch","openApiOperationId":"idvSearch","summary":"Execute IDV 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/IdvRequestDto","mediaTypes":["application/json","text/json","application/*+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/IdvRequestDto"},"text/json":{"schemaId":"components/schemas/IdvRequestDto"},"application/*+json":{"schemaId":"components/schemas/IdvRequestDto"}},"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","text/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/IdvResponseDto"},"text/json":{"schemaId":"components/schemas/IdvResponseDto"}},"schemaId":"components/schemas/IdvResponseDto"},{"code":"400","mediaType":"text/plain","mediaTypes":["text/plain","application/json","text/json"],"mediaTypeContent":{"text/plain":{"schemaId":"components/schemas/ConnectProtectProblemDetails"},"application/json":{"schemaId":"components/schemas/ConnectProtectProblemDetails"},"text/json":{"schemaId":"components/schemas/ConnectProtectProblemDetails"}},"schemaId":"components/schemas/ConnectProtectProblemDetails"}],"pointer":"/paths/~1protect~1idv~1gdc~1search/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/IdvResponseDto","mediaTypes":["application/json","text/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/IdvResponseDto"},"text/json":{"schemaId":"components/schemas/IdvResponseDto"}}},{"code":"400","schemaId":"components/schemas/ConnectProtectProblemDetails","mediaTypes":["text/plain","application/json","text/json"],"mediaTypeContent":{"text/plain":{"schemaId":"components/schemas/ConnectProtectProblemDetails"},"application/json":{"schemaId":"components/schemas/ConnectProtectProblemDetails"},"text/json":{"schemaId":"components/schemas/ConnectProtectProblemDetails"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/idv-(legacy)/idvsearch"}],"panels":[]}]},"httpPath":"/protect/idv/gdc/search"}],"content":{"contentType":"group","meta":{"name":"IDV (Legacy)"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"IDV (Legacy)","showPageActions":true},{"nodeType":"markdoc","content":"Person identity verification by validating against other known sources."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/protect/idv/file","summary":"Return IDV Report","prefix":{"name":"get","color":"get"},"badges":[],"link":"/idv-(legacy)/returnsidvreport","deprecated":false},{"title":"/protect/idv/gdc/search","summary":"Execute IDV Search","prefix":{"name":"post","color":"post"},"badges":[],"link":"/idv-(legacy)/idvsearch","deprecated":false}]}]}]}]}},{"type":"separator","label":"Consumers and Misc","content":null},{"type":"group","label":"European Consumers","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/european-consumers","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/european-consumers","items":[{"label":"Consumer Report","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/european-consumers/consumerreport","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/european-consumers/consumerreport","metadata":{"seo":{"title":"Consumer Report","description":"Consumer Search and Report endpoint. When sufficient information has been provided to filter potential Consumer results down to one record then the Consumer Report will be returned."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"consumerReport","name":"Consumer Report","isWebhook":false,"pointer":"/paths/~1consumers/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Consumer Report","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Consumer Search and Report endpoint. When sufficient information has been provided to filter potential Consumer results down to one record then the Consumer Report will be returned."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API requires authentication for access to protected endpoints. Authentication is performed by providing a valid JWT token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"countries","in":"query","schemaId":"schema_387","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-2 country code. Only available for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Germany) and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Netherlands)"},"children":[]}]}]}],"required":true,"example":"DE"},{"name":"language","in":"query","schemaId":"schema_511","description":""},{"name":"firstName","in":"query","schemaId":"schema_387","description":"Consumer's First Name","required":true},{"name":"lastName","in":"query","schemaId":"schema_387","description":"Consumer's Last Name","required":true},{"name":"street","in":"query","schemaId":"schema_387","description":"Address part identifier - Street of the Consumer","required":true},{"name":"houseNo","in":"query","schemaId":"schema_387","description":"Address part identifier - House/Building Number of the Consumer","required":true},{"name":"city","in":"query","schemaId":"schema_387","description":"Address part identifier - City of the Consumer","required":true},{"name":"postCode","in":"query","schemaId":"schema_387","description":"Address part identifier - Postcode/Zip Code of the Consumer","required":true},{"name":"dateOfBirth","in":"query","schemaId":"schema_430"},{"name":"customData","in":"query","schemaId":"schema_411","example":"de_reason_code::ER"},{"name":"callRef","in":"query","schemaId":"schema_410","description":"This parameter allows users to assign a unique identifier to their API queries. By using a callRef, it facilitates easier tracking and logging within Connect. If you provide a callRef, the Connect team can later retrieve and identify the specific requests associated with that identifier, enabling detailed tracing of interactions."}],"pointer":"/paths/~1consumers/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/consumers","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[],"query":[{"name":"countries","in":"query","required":true,"example":"DE","schemaId":"schema_387"},{"name":"language","in":"query","schemaId":"schema_511"},{"name":"firstName","in":"query","required":true,"schemaId":"schema_387"},{"name":"lastName","in":"query","required":true,"schemaId":"schema_387"},{"name":"street","in":"query","required":true,"schemaId":"schema_387"},{"name":"houseNo","in":"query","required":true,"schemaId":"schema_387"},{"name":"city","in":"query","required":true,"schemaId":"schema_387"},{"name":"postCode","in":"query","required":true,"schemaId":"schema_387"},{"name":"dateOfBirth","in":"query","schemaId":"schema_430"},{"name":"customData","in":"query","example":"de_reason_code::ER","schemaId":"schema_411"},{"name":"callRef","in":"query","schemaId":"schema_410"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401"],"pointer":"/consumers","href":"european-consumers/consumerreport","openApiOperationId":"consumerReport","summary":"Consumer Report"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_512"}},"schemaId":"schema_512"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}},"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}],"pointer":"/paths/~1consumers/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_512","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_512"}}},{"code":"400","schemaId":"components/schemas/ConnectErrorResponsesBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}}},{"code":"401","schemaId":"components/schemas/ConnectErrorResponsesInvalidToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/european-consumers/consumerreport"}],"panels":[]}]},"httpPath":"/consumers"},{"label":"Return European Consumer Search Criteria","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/european-consumers/consumersearchcriteria","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/european-consumers/consumersearchcriteria","metadata":{"seo":{"title":"Return European Consumer Search Criteria","description":"Returns country specific fields that can be used to search for a Consumer."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"consumerSearchCriteria","name":"Return European Consumer Search Criteria","isWebhook":false,"pointer":"/paths/~1consumers~1searchcriteria/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return European Consumer Search Criteria","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns country specific fields that can be used to search for a Consumer."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API requires authentication for access to protected endpoints. Authentication is performed by providing a valid JWT token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"countries","in":"query","schemaId":"schema_387","description":"Comma-separated list of ISO-2 country codes","required":true,"example":"de"},{"name":"callRef","in":"query","schemaId":"schema_387","description":"This parameter allows users to assign a unique identifier to their API queries. By using a callRef, it facilitates easier tracking and logging within Connect. If you provide a callRef, the Connect team can later retrieve and identify the specific requests associated with that identifier, enabling detailed tracing of interactions."}],"pointer":"/paths/~1consumers~1searchcriteria/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/consumers/searchcriteria","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[],"query":[{"name":"countries","in":"query","required":true,"example":"de","schemaId":"schema_387"},{"name":"callRef","in":"query","schemaId":"schema_387"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401"],"pointer":"/consumers/searchcriteria","href":"european-consumers/consumersearchcriteria","openApiOperationId":"consumerSearchCriteria","summary":"Return European Consumer Search Criteria"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_513"}},"schemaId":"schema_513"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}},"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}],"pointer":"/paths/~1consumers~1searchcriteria/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_513","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_513"}}},{"code":"400","schemaId":"components/schemas/ConnectErrorResponsesBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}}},{"code":"401","schemaId":"components/schemas/ConnectErrorResponsesInvalidToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/european-consumers/consumersearchcriteria"}],"panels":[]}]},"httpPath":"/consumers/searchcriteria"},{"label":"Return Custom Report Parameters","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/european-consumers/customreportparameters","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/european-consumers/customreportparameters","metadata":{"seo":{"title":"Return Custom Report Parameters","description":"Returns the allowed values of the customData parameter.Used in the GET Company Report and Director Report endpoints.  I.e. Supplying DE as a country code will return a list of reasons for requesting a DE Credit Report (a legal requirement to supply with each Credit Report request in Germany). This will provide a list of allowedValues to enter into the mandatory Parameter customData = de_reason_code::allowedValue."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"customReportParameters","name":"Return Custom Report Parameters","isWebhook":false,"pointer":"/paths/~1reportcustomdata~1{country}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return Custom Report Parameters","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the allowed values of the customData parameter."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET Company Report and Director Report endpoints"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":".  I.e. Supplying "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as a country code will return a list of reasons for requesting a DE Credit Report (a legal requirement to supply with each Credit Report request in Germany). This will provide a list of allowedValues to enter into the mandatory Parameter "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customData"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"de_reason_code::allowedValue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API requires authentication for access to protected endpoints. Authentication is performed by providing a valid JWT token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"country","in":"path","schemaId":"schema_387","description":"An ISO/Alpha-2 country code to display any special mandatory parameters when ordering a Credit Report in that territory.","required":true}],"pointer":"/paths/~1reportcustomdata~1{country}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/reportcustomdata/{country}","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[{"name":"country","in":"path","required":true,"schemaId":"schema_387"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401"],"pointer":"/reportcustomdata/{country}","href":"european-consumers/customreportparameters","openApiOperationId":"customReportParameters","summary":"Return Custom Report Parameters"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_514"}},"schemaId":"schema_514"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}},"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}],"pointer":"/paths/~1reportcustomdata~1{country}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_514","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_514"}}},{"code":"400","schemaId":"components/schemas/ConnectErrorResponsesBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}}},{"code":"401","schemaId":"components/schemas/ConnectErrorResponsesInvalidToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/european-consumers/customreportparameters"}],"panels":[]}]},"httpPath":"/reportcustomdata/{country}"}],"content":{"contentType":"group","meta":{"name":"European Consumers"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"European Consumers","showPageActions":true},{"nodeType":"markdoc","content":"Endpoints for searching and retrieving European consumer credit reports (Sweden, Norway, Netherlands, Germany) based on provided search criteria."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/consumers","summary":"Consumer Report","prefix":{"name":"get","color":"get"},"badges":[],"link":"/european-consumers/consumerreport","deprecated":false},{"title":"/consumers/searchcriteria","summary":"Return European Consumer Search Criteria","prefix":{"name":"get","color":"get"},"badges":[],"link":"/european-consumers/consumersearchcriteria","deprecated":false},{"title":"/reportcustomdata/{country}","summary":"Return Custom Report Parameters","prefix":{"name":"get","color":"get"},"badges":[],"link":"/european-consumers/customreportparameters","deprecated":false}]}]}]}]}},{"type":"group","label":"US Consumers","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/us-consumers","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/us-consumers","items":[{"label":"US Consumer Report","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/us-consumers/consumertryreport","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/us-consumers/consumertryreport","metadata":{"seo":{"title":"US Consumer Report","description":"Search for US consumer based on provided criteria. Returns a consumer report with credit information,  trade lines, negative information, and employment details."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"consumerTryReport","name":"US Consumer Report","isWebhook":false,"pointer":"/paths/~1consumers~1tryReport/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"US Consumer Report","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search for US consumer based on provided criteria. Returns a consumer report with credit information,  trade lines, negative information, and employment details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Template Options:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"basic"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Standard consumer report without credit score. No footprint left on consumer's credit file."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hardcheck"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Includes credit score in response and leaves a footprint (inquiry) on the consumer's credit file. Used for actual credit decisions."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API requires authentication for access to protected endpoints. Authentication is performed by providing a valid JWT token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"countries","in":"query","schemaId":"schema_515","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A single country code in ISO-2 format. Must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"US"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for US consumer reports."},"children":[]}]}]}],"required":true,"example":"US"},{"name":"firstName","in":"query","schemaId":"schema_387","description":"First name of US consumer","required":true},{"name":"lastName","in":"query","schemaId":"schema_387","description":"Last name of US consumer","required":true},{"name":"template","in":"query","schemaId":"schema_516","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Consumer report template.  "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"basic"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (default) returns report without credit score and leaves no footprint.  "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hardcheck"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" includes credit score and leaves an inquiry on the consumer's credit file."},"children":[]}]}]}]},{"name":"personNumber","in":"query","schemaId":"schema_517","description":"Social security number (SSN) of US Consumer"},{"name":"dateOfBirth","in":"query","schemaId":"schema_478","description":"Date of birth of US Consumer (format YYYY-MM-DD)"},{"name":"street","in":"query","schemaId":"schema_387","description":"Street name and house number of US consumer"},{"name":"city","in":"query","schemaId":"schema_387","description":"City of US consumer"},{"name":"postalCode","in":"query","schemaId":"schema_387","description":"Postal / zip code of US consumer"},{"name":"province","in":"query","schemaId":"schema_515","description":"US state of US consumer (2-letter state code, e.g., AL, CA, NY)"},{"name":"telephone","in":"query","schemaId":"schema_387","description":"Telephone number of US consumer"}],"pointer":"/paths/~1consumers~1tryReport/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/consumers/tryReport","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[],"query":[{"name":"countries","in":"query","required":true,"example":"US","schemaId":"schema_515"},{"name":"firstName","in":"query","required":true,"schemaId":"schema_387"},{"name":"lastName","in":"query","required":true,"schemaId":"schema_387"},{"name":"template","in":"query","schemaId":"schema_516"},{"name":"personNumber","in":"query","schemaId":"schema_517"},{"name":"dateOfBirth","in":"query","schemaId":"schema_478"},{"name":"street","in":"query","schemaId":"schema_387"},{"name":"city","in":"query","schemaId":"schema_387"},{"name":"postalCode","in":"query","schemaId":"schema_387"},{"name":"province","in":"query","schemaId":"schema_515"},{"name":"telephone","in":"query","schemaId":"schema_387"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403"],"pointer":"/consumers/tryReport","href":"us-consumers/consumertryreport","openApiOperationId":"consumerTryReport","summary":"US Consumer Report"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Consumer TryReport response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreditsafeGlobalDataReportsConsumerCsusTryReportResponse"}},"schemaId":"components/schemas/CreditsafeGlobalDataReportsConsumerCsusTryReportResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}},"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}},"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}],"pointer":"/paths/~1consumers~1tryReport/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CreditsafeGlobalDataReportsConsumerCsusTryReportResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreditsafeGlobalDataReportsConsumerCsusTryReportResponse"}}},{"code":"400","schemaId":"components/schemas/ConnectErrorResponsesBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}}},{"code":"401","schemaId":"components/schemas/ConnectErrorResponsesInvalidToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}}},{"code":"403","schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/us-consumers/consumertryreport"}],"panels":[]}]},"httpPath":"/consumers/tryReport"},{"label":"Return US Consumers Search Criteria","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/us-consumers/consumertryreportsearchcriteria","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi/us-consumers/consumertryreportsearchcriteria","metadata":{"seo":{"title":"Return US Consumers Search Criteria","description":"Returns country specific fields that can be used to search for a US Consumer TryReport. Use this endpoint to discover all supported search criteria query parameters and validation rules for the /consumers/tryReport endpoint."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"consumerTryReportSearchCriteria","name":"Return US Consumers Search Criteria","isWebhook":false,"pointer":"/paths/~1consumers~1tryReport~1searchcriteria/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return US Consumers Search Criteria","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns country specific fields that can be used to search for a US Consumer TryReport.  Use this endpoint to discover all supported search criteria query parameters and validation rules  for the /consumers/tryReport endpoint."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API requires authentication for access to protected endpoints. Authentication is performed by providing a valid JWT token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"countries","in":"query","schemaId":"schema_387","description":"ISO-2 country code","required":true,"example":"US"}],"pointer":"/paths/~1consumers~1tryReport~1searchcriteria/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/consumers/tryReport/searchcriteria","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[],"query":[{"name":"countries","in":"query","required":true,"example":"US","schemaId":"schema_387"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403"],"pointer":"/consumers/tryReport/searchcriteria","href":"us-consumers/consumertryreportsearchcriteria","openApiOperationId":"consumerTryReportSearchCriteria","summary":"Return US Consumers Search Criteria"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_518"}},"schemaId":"schema_518"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}},"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}},"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}],"pointer":"/paths/~1consumers~1tryReport~1searchcriteria/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_518","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_518"}}},{"code":"400","schemaId":"components/schemas/ConnectErrorResponsesBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}}},{"code":"401","schemaId":"components/schemas/ConnectErrorResponsesInvalidToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}}},{"code":"403","schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/us-consumers/consumertryreportsearchcriteria"}],"panels":[]}]},"httpPath":"/consumers/tryReport/searchcriteria"}],"content":{"contentType":"group","meta":{"name":"US Consumers"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"US Consumers","showPageActions":true},{"nodeType":"markdoc","content":"Endpoints for searching and retrieving US consumer credit reports based on provided search criteria."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/consumers/tryReport","summary":"US Consumer Report","prefix":{"name":"get","color":"get"},"badges":[],"link":"/us-consumers/consumertryreport","deprecated":false},{"title":"/consumers/tryReport/searchcriteria","summary":"Return US Consumers Search Criteria","prefix":{"name":"get","color":"get"},"badges":[],"link":"/us-consumers/consumertryreportsearchcriteria","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/ConnectAuthenticationAccessCountries":{"id":"components/schemas/ConnectAuthenticationAccessCountries","kind":"json-schema","title":"ConnectAuthenticationAccessCountries","data":{"type":"object","properties":{"correlationId":{"type":"string"},"countryAccess":{"type":"object","properties":{"creditsafeConnectOnlineReports":{"type":"array","description":"Country usage for Company Reports service","items":{"type":"object","properties":{"countryName":{"type":"string"},"templateName":{"type":"string","description":"Company Report template. Full reports are default"},"countryIso2":{"type":"string"},"startDate":{"type":"string","description":"Date of when the service was enabled"},"expireDate":{"type":"string","description":"Date of when the service will expire"},"paid":{"type":"integer","description":"Measure of total usage available in the service"},"used":{"type":"integer","description":"Service usage"}}}},"creditsafeConnectOfflineReports":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"countryIso2":{"type":"string"},"startDate":{"type":"string","description":"Date of when the service was enabled"},"expireDate":{"type":"string","description":"Date of when the service will expire"},"paid":{"type":"integer","description":"Measure of total usage available in the service"},"used":{"type":"integer","description":"Service usage"}}}},"creditsafeConnectMonitoring":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"startDate":{"type":"string","description":"Date of when the service was enabled"},"expireDate":{"type":"string","description":"Date of when the service will expire"},"paid":{"type":"integer","description":"Measure of total usage available in the service"},"used":{"type":"integer","description":"Service usage"}}}},"creditsafeConnectDirectorReports":{"type":"array","items":{"type":"object","properties":{"countryName":{"type":"string"},"countryIso2":{"type":"string"},"startDate":{"type":"string","description":"Date of when the service was enabled"},"expireDate":{"type":"string","description":"Date of when the service will expire"},"paid":{"type":"integer","description":"Measure of total usage available in the service"},"used":{"type":"integer","description":"Service usage"}}}},"creditsafeConnectImageDocuments":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"countryIso2":{"type":"string"},"startDate":{"type":"string","description":"Date of when the service was enabled"},"expireDate":{"type":"string","description":"Date of when the service will expire"},"paid":{"type":"integer","description":"Measure of total usage available in the service"},"used":{"type":"integer","description":"Service usage"}}}},"creditsafeConnectBankValidation":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"startDate":{"type":"string","description":"Date of when the service was enabled"},"expireDate":{"type":"string","description":"Date of when the service will expire"},"paid":{"type":"integer","description":"Measure of total usage available in the service"},"used":{"type":"integer","description":"Service usage"}}}},"creditsafeConnectBankVerification":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"startDate":{"type":"string","description":"Date of when the service was enabled"},"expireDate":{"type":"string","description":"Date of when the service will expire"},"paid":{"type":"integer","description":"Measure of total usage available in the service"},"used":{"type":"integer","description":"Service usage"}}}}}}}}},"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/KycProtectGetCustomerUsersDetailsResponse":{"id":"components/schemas/KycProtectGetCustomerUsersDetailsResponse","kind":"json-schema","title":"KycProtectGetCustomerUsersDetailsResponse","data":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"firstName":{"type":"string","description":"First name of the user.","example":"connect"},"surname":{"type":"string","description":"Surname name of the user.","example":"connect"},"userId":{"type":"integer","description":"Id of the user.","format":"int32","example":101534481}}}},"totalSize":{"type":"integer","format":"int64"}}}},"components/schemas/KycProtectGetMyUserDetailsResponse":{"id":"components/schemas/KycProtectGetMyUserDetailsResponse","kind":"json-schema","title":"KycProtectGetMyUserDetailsResponse","data":{"type":"object","properties":{"username":{"type":"string","description":"The name of the user.","example":"Raj"},"emailAddress":{"type":"string","description":"The email address of the user.","example":"connectm1@mailinator.com"},"owningEntity":{"type":"string","description":"Owning entity of the user.","example":"CSUS"},"defaultLanguage":{"type":"string","description":"user default language.","example":"EN"},"primaryContact":{"type":"object","properties":{"title":{"type":"string","description":"Title of the user primary contact.","example":""},"firstName":{"type":"string","description":"firstName of the user primary contact.","example":""},"surname":{"type":"string","description":"surname of the user primary contact.","example":""}}},"ietfLanguage":{"type":"string","description":"user default language.","example":"en-GB"},"countryCode":{"type":"string","description":"country code of the user.","example":"en-GB"},"isActive":{"type":"string","description":"status of the user.","example":true},"correlationId":{"type":"string","description":"A unique ID assigned to this request.","example":"23921650-c073-11ea-860f-06bc8182190e"}}}},"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/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/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/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/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/ConnectConfidenceMatchMatchResults":{"id":"components/schemas/ConnectConfidenceMatchMatchResults","kind":"json-schema","title":"ConnectConfidenceMatchMatchResults","data":{"properties":{"totalMatches":{"type":"integer","description":"The total number of companies matched in the search results."},"matchedCompanies":{"type":"array","description":"A list of companies that matched the search criteria.","items":{"type":"object","properties":{"matchScoreConfidence":{"type":"integer","description":"The confidence score for the match, indicating the likelihood of a correct match (higher is better)."},"id":{"type":"string","description":"The unique identifier for the matched company."},"country":{"type":"string","description":"The ISO country code of the matched company."},"regNo":{"type":"string","description":"The registration number of the matched company."},"safeNo":{"type":"string","description":"The Creditsafe Safe Number for the matched company."},"name":{"type":"string","description":"The name of the matched company."},"phoneNo":{"type":"string","description":"The main phone number of the matched company."},"address":{"type":"object","description":"The address details of the matched company.","properties":{"simpleValue":{"type":"string","description":"A simplified, single-line version of the address."},"street":{"type":"string","description":"The street name of the address."},"city":{"type":"string","description":"The city of the address."},"postcode":{"type":"string","description":"The postal code of the address."},"country":{"type":"string","description":"The ISO country code of the address."},"state":{"type":"string","description":"The state or region of the address."}}},"status":{"type":"string","description":"The current status of the matched company (e.g., Active, Inactive)."},"statusDescription":{"type":"string","description":"Additional description of the company's status (e.g., Non trading)."},"type":{"type":"string","description":"The type or classification of the matched company (e.g., Ltd)."},"activityCode":{"type":"string","description":"The activity code (industry classification) of the matched company."},"officeType":{"type":"string","description":"The office type of the company. Only available with US companies."},"dateOfLatestAccounts":{"type":"string","description":"The date of the latest accounts filed by the company (ISO 8601 format)."},"dateOfLatestChange":{"type":"string","description":"The date of the latest change to the company's details (ISO 8601 format)."},"matchScoreExplainPlan":{"type":"object","description":"Detailed breakdown of the match score calculation for the company.   Each field uses a grading system to indicate the quality of the match: - \"A\": Exact match - \"B\": Close match - \"C\": Partial match - \"D\": Similar in essence (e.g., ignoring common industry keywords) - \"O\": No match - \"X\": Not applicable or not compared\n","properties":{"matchScore":{"type":"integer","description":"The overall match score for the company."},"matchScoreAlpha":{"type":"string","description":"The alphabetical match score component."},"matchScoreLocal Id":{"type":"string","description":"The match score component for the local identifier."},"matchScoreName":{"type":"string","description":"The match score for the company name."},"matchScoreHouseNo":{"type":"string","description":"The match score for the house number."},"matchScoreStreet":{"type":"string","description":"The match score for the street."},"matchScorePoBox":{"type":"string","description":"The match score for the PO Box."},"matchScoreCity":{"type":"string","description":"The match score for the city."},"matchScoreState":{"type":"string","description":"The match score for the province or state."},"matchScorePostCode":{"type":"string","description":"The match score for the postal code."},"matchScoreCountry":{"type":"string","description":"The match score for the country."},"matchScoreVatNo":{"type":"string","description":"The match score for the VAT number."},"matchScoreRegNo":{"type":"string","description":"The match score for the registration number."},"matchScorePhoneNo":{"type":"string","description":"The match score for the phone number."},"matchScoreSimpleValue":{"type":"string","description":"The match score for the simple value address."},"matchScoreNum":{"type":"string","description":"The match score for the numeric value."}}}}}}}}},"components/schemas/ConnectConfidenceMatchNoResults":{"id":"components/schemas/ConnectConfidenceMatchNoResults","kind":"json-schema","title":"ConnectConfidenceMatchNoResults","data":{"properties":{"totalMatches":{"type":"integer"},"matchedCompanies":{"type":"array","items":{"type":"string"}}}}},"components/schemas/CreditsafeGlobalDataSearchCriteriaSchemaBase":{"id":"components/schemas/CreditsafeGlobalDataSearchCriteriaSchemaBase","kind":"json-schema","title":"CreditsafeGlobalDataSearchCriteriaSchemaBase","data":{"type":"object"}},"components/schemas/CreditsafeGlobalDataSearchCriteriaSchema-ValueSchema_1_SystemString":{"id":"components/schemas/CreditsafeGlobalDataSearchCriteriaSchema-ValueSchema_1_SystemString","kind":"json-schema","title":"CreditsafeGlobalDataSearchCriteriaSchema-ValueSchema_1_SystemString","data":{"type":"object","properties":{"required":{"type":"boolean"},"minLength":{"type":["integer","null"],"format":"int32"},"maxLength":{"type":["integer","null"],"format":"int32"},"allowedValues":{"type":"array","items":{"type":"string"}},"validationRegExp":{"type":"string"}}}},"components/schemas/CreditsafeGlobalDataSearchCriteriaSchema-QueryStringSchema":{"id":"components/schemas/CreditsafeGlobalDataSearchCriteriaSchema-QueryStringSchema","kind":"json-schema","title":"CreditsafeGlobalDataSearchCriteriaSchema-QueryStringSchema","data":{"allOf":[{"$ref":"#/components/schemas/CreditsafeGlobalDataSearchCriteriaSchema-ValueSchema_1_SystemString"}]}},"components/schemas/CreditsafeGlobalDataSearchCriteriaSchema-ValueSchema_1_CreditsafeGlobalDataCompanyType":{"id":"components/schemas/CreditsafeGlobalDataSearchCriteriaSchema-ValueSchema_1_CreditsafeGlobalDataCompanyType","kind":"json-schema","title":"CreditsafeGlobalDataSearchCriteriaSchema-ValueSchema_1_CreditsafeGlobalDataCompanyType","data":{"type":"object","properties":{"optional":{"type":"boolean"},"minLength":{"type":["integer","null"],"format":"int32"},"maxLength":{"type":["integer","null"],"format":"int32"},"allowedValues":{"type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataCompanyType"}},"validationRegExp":{"type":"string"}}}},"components/schemas/CreditsafeGlobalDataSearchCriteriaSchema-ValueSchema_1_CreditsafeGlobalDataOfficeType":{"id":"components/schemas/CreditsafeGlobalDataSearchCriteriaSchema-ValueSchema_1_CreditsafeGlobalDataOfficeType","kind":"json-schema","title":"CreditsafeGlobalDataSearchCriteriaSchema-ValueSchema_1_CreditsafeGlobalDataOfficeType","data":{"type":"object","properties":{"optional":{"type":"boolean"},"minLength":{"type":["integer","null"],"format":"int32"},"maxLength":{"type":["integer","null"],"format":"int32"},"allowedValues":{"type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataOfficeType"}},"validationRegExp":{"type":"string"}}}},"components/schemas/CreditsafeGlobalDataSearchCriteriaSchema-ValueSchema_1_CreditsafeGlobalDataCompanyStatus":{"id":"components/schemas/CreditsafeGlobalDataSearchCriteriaSchema-ValueSchema_1_CreditsafeGlobalDataCompanyStatus","kind":"json-schema","title":"CreditsafeGlobalDataSearchCriteriaSchema-ValueSchema_1_CreditsafeGlobalDataCompanyStatus","data":{"type":"object","properties":{"optional":{"type":"boolean"},"minLength":{"type":["integer","null"],"format":"int32"},"maxLength":{"type":["integer","null"],"format":"int32"},"allowedValues":{"type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataCompanyStatus"}},"validationRegExp":{"type":"string"}}}},"components/schemas/CreditsafeGlobalDataAddressCriteriaSchema":{"id":"components/schemas/CreditsafeGlobalDataAddressCriteriaSchema","kind":"json-schema","title":"CreditsafeGlobalDataAddressCriteriaSchema","data":{"type":"object","properties":{"simpleValue":{"$ref":"#/components/schemas/CreditsafeGlobalDataSearchCriteriaSchema-QueryStringSchema"},"street":{"$ref":"#/components/schemas/CreditsafeGlobalDataSearchCriteriaSchema-ValueSchema_1_SystemString"},"houseNo":{"$ref":"#/components/schemas/CreditsafeGlobalDataSearchCriteriaSchema-ValueSchema_1_SystemString"},"city":{"$ref":"#/components/schemas/CreditsafeGlobalDataSearchCriteriaSchema-ValueSchema_1_SystemString"},"postCode":{"$ref":"#/components/schemas/CreditsafeGlobalDataSearchCriteriaSchema-ValueSchema_1_SystemString"},"province":{"$ref":"#/components/schemas/CreditsafeGlobalDataSearchCriteriaSchema-ValueSchema_1_SystemString"}}}},"components/schemas/CreditsafeGlobalDataSearchCriteriaSchema-ValueSchema_1_SystemBoolean":{"id":"components/schemas/CreditsafeGlobalDataSearchCriteriaSchema-ValueSchema_1_SystemBoolean","kind":"json-schema","title":"CreditsafeGlobalDataSearchCriteriaSchema-ValueSchema_1_SystemBoolean","data":{"type":"object","properties":{"optional":{"type":"boolean"},"minLength":{"type":["integer","null"],"format":"int32"},"maxLength":{"type":["integer","null"],"format":"int32"},"allowedValues":{"type":"array","items":{"type":"boolean"}},"validationRegExp":{"type":"string"}}}},"components/schemas/CreditsafeGlobalDataSearchCriteriaSchema":{"id":"components/schemas/CreditsafeGlobalDataSearchCriteriaSchema","kind":"json-schema","title":"CreditsafeGlobalDataSearchCriteriaSchema","data":{"allOf":[{"$ref":"#/components/schemas/CreditsafeGlobalDataSearchCriteriaSchemaBase"},{"type":"object","properties":{"id":{"$ref":"#/components/schemas/CreditsafeGlobalDataSearchCriteriaSchema-ValueSchema_1_SystemString"},"safeNo":{"$ref":"#/components/schemas/CreditsafeGlobalDataSearchCriteriaSchema-ValueSchema_1_SystemString"},"regNo":{"$ref":"#/components/schemas/CreditsafeGlobalDataSearchCriteriaSchema-ValueSchema_1_SystemString"},"vatNo":{"$ref":"#/components/schemas/CreditsafeGlobalDataSearchCriteriaSchema-ValueSchema_1_SystemString"},"name":{"$ref":"#/components/schemas/CreditsafeGlobalDataSearchCriteriaSchema-QueryStringSchema"},"type":{"$ref":"#/components/schemas/CreditsafeGlobalDataSearchCriteriaSchema-ValueSchema_1_CreditsafeGlobalDataCompanyType"},"officeType":{"$ref":"#/components/schemas/CreditsafeGlobalDataSearchCriteriaSchema-ValueSchema_1_CreditsafeGlobalDataOfficeType"},"status":{"$ref":"#/components/schemas/CreditsafeGlobalDataSearchCriteriaSchema-ValueSchema_1_CreditsafeGlobalDataCompanyStatus"},"address":{"$ref":"#/components/schemas/CreditsafeGlobalDataAddressCriteriaSchema"},"phoneNumber":{"$ref":"#/components/schemas/CreditsafeGlobalDataSearchCriteriaSchema-ValueSchema_1_SystemString"},"website":{"$ref":"#/components/schemas/CreditsafeGlobalDataSearchCriteriaSchema-ValueSchema_1_SystemString"},"includeTradingNames":{"$ref":"#/components/schemas/CreditsafeGlobalDataSearchCriteriaSchema-ValueSchema_1_SystemBoolean"},"includeTradingAddresses":{"$ref":"#/components/schemas/CreditsafeGlobalDataSearchCriteriaSchema-ValueSchema_1_SystemBoolean"}}}]}},"components/schemas/CreditsafeGlobalDataSearchCriteriaSchemaCountry":{"id":"components/schemas/CreditsafeGlobalDataSearchCriteriaSchemaCountry","kind":"json-schema","title":"CreditsafeGlobalDataSearchCriteriaSchemaCountry","data":{"type":"object","properties":{"correlationId":{"type":"string","description":"A unique ID assigned to this request."},"countries":{"type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataCountryCode"}},"languages":{"type":"array","description":"Available languages to perform a company search in the country queried","items":{"type":"string"}},"criteriaSets":{"type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataSearchCriteriaSchema"}}}}},"components/schemas/BankMatchBBANCompanySearch":{"id":"components/schemas/BankMatchBBANCompanySearch","kind":"json-schema","title":"BankMatchBBANCompanySearch","data":{"type":"object","description":"Response object for BBAN company search in bank matching.","properties":{"id":{"type":"string","description":"Unique identifier for the bank match search."},"classification":{"type":"string","description":"Classification result of the search (e.g., 'NO')."},"status":{"type":"string","description":"Status of the search process (e.g., 'SUCCEEDED')."},"entity":{"type":"object","description":"Contains details about the entity associated with the BBAN.","properties":{"paymentIdentity":{"type":"object","properties":{"id":{"type":"string","description":"The payment identity ID."},"iban":{"type":"string","description":"International Bank Account Number (IBAN)."},"bic":{"type":"string","description":"Bank Identifier Code (BIC)."},"countryCode":{"type":"string","description":"Country code of the bank account."},"bban":{"type":"string","description":"Basic Bank Account Number (BBAN)."},"routingCode":{"type":"string","description":"Routing code for the bank account."},"type":{"type":"string","description":"Type of payment identity (e.g., 'BBAN')."}}},"company":{"type":"object","properties":{"registrationId":{"type":"string","description":"Registration ID of the company."},"name":{"type":"string","description":"Name of the company."},"legalPerson":{"type":"boolean","description":"Indicates if the entity is a legal person."},"typeId":{"type":"string","description":"Type identifier of the company."},"countryCode":{"type":"string","description":"Country code of the company."},"status":{"type":"string","description":"Status of the company."}}}}},"input":{"type":"object","description":"Input details used for the search.","properties":{"paymentIdentity":{"type":"object","description":"Payment identity details provided in the input.","properties":{"countryCode":{"type":"string","description":"Country code of the bank account."},"bic":{"type":"string","description":"BIC provided in the input."},"bban":{"type":"string","description":"BBAN provided in the input."},"routingCode":{"type":"string","description":"Routing code provided in the input."}}},"company":{"type":"object","description":"Company details provided in the input.","properties":{"registrationId":{"type":"string","description":"Registration ID of the input company."},"countryCode":{"type":"string","description":"Country code of the input company."}}}}},"reasons":{"type":"array","items":{"type":"string"},"description":"List of reason codes for the result."},"sepamailVerificationStatus":{"type":"string","description":"Status of the SepaMail verification."},"reasonLabels":{"type":"object","additionalProperties":{"type":"string"},"description":"Labels describing the reasons for the result."}}}},"components/schemas/BankMatchIBANCompanySearchAcceptedResponse":{"id":"components/schemas/BankMatchIBANCompanySearchAcceptedResponse","kind":"json-schema","title":"BankMatchIBANCompanySearchAcceptedResponse","data":{"type":"object","properties":{"correlationId":{"type":"string","format":"uuid","example":"78ba8a1a-a614-4d7a-bcc3-ea682cd6b510"},"checkId":{"type":"string","format":"uuid","example":"6889c5ef-8975-0f4f-c832-26cd6889c5ef"},"message":{"type":"string","example":"The company details are currently being verified. You can track the progress of this request on the /localSolutions/FR/bankmatch/audition?audition_id={audition_id} endpoint."}}}},"components/schemas/ConnectErrorResponsesResourceConflictResponse":{"id":"components/schemas/ConnectErrorResponsesResourceConflictResponse","kind":"json-schema","title":"ConnectErrorResponsesResourceConflictResponse","data":{"type":"object","description":"409 - Conflict","properties":{"correlationId":{"description":"The unique identifier. (A UUID specified by RFC4122).","type":"string","format":"uuid"},"message":{"type":"string"},"details":{"type":"string","description":"Provides further information on why the request was rejected"}}}},"components/schemas/BankMatchBBANCompanySearchCriteria":{"id":"components/schemas/BankMatchBBANCompanySearchCriteria","kind":"json-schema","title":"BankMatchBBANCompanySearchCriteria","data":{"type":"object","description":"Criteria for searching a company using BBAN in the bank matching system.","properties":{"correlationId":{"type":"string","description":"Unique identifier for the request."},"criteriaSets":{"type":"array","description":"A list of criteria sets for matching a company.","items":{"type":"object","properties":{"regNo":{"type":"object","properties":{"required":{"type":"boolean","description":"Indicates if registration number is required."}}},"bban":{"type":"object","properties":{"validationRegExp":{"type":"string","description":"Regular expression for BBAN validation."},"required":{"type":"boolean","description":"Indicates if BBAN is required."}}},"bic":{"type":"object","properties":{"validationRegExp":{"type":"string","description":"Regular expression for BIC validation."},"required":{"type":"boolean","description":"Indicates if BIC is required."}}},"routingCode":{"type":"object","properties":{"validationRegExp":{"type":"string","description":"Regular expression for routing code validation."},"required":{"type":"boolean","description":"Indicates if routing code is required."}}}}}},"country":{"type":"string","description":"The country code where the search criteria applies (e.g., \"US\")."}}}},"components/schemas/BankMatchIBANCompanySearch":{"id":"components/schemas/BankMatchIBANCompanySearch","kind":"json-schema","title":"BankMatchIBANCompanySearch","data":{"type":"object","description":"Response object for IBAN company search in bank matching.","properties":{"id":{"type":"string","description":"Unique identifier for the bank match search."},"classification":{"type":"string","description":"Classification result of the search (e.g., 'NO')."},"status":{"type":"string","description":"Status of the search process (e.g., 'SUCCEEDED')."},"entity":{"type":"object","description":"Contains details about the entity associated with the IBAN.","properties":{"paymentIdentity":{"type":"object","properties":{"id":{"type":"string","description":"The payment identity ID."},"iban":{"type":"string","description":"International Bank Account Number (IBAN)."},"type":{"type":"string","description":"Type of payment identity (e.g., 'IBAN')."}}},"company":{"type":"object","properties":{"registrationId":{"type":"string","description":"Registration ID of the company."},"name":{"type":"string","description":"Name of the company."},"legalPerson":{"type":"boolean","description":"Indicates if the entity is a legal person."},"typeId":{"type":"string","description":"Type identifier of the company."},"countryCode":{"type":"string","description":"Country code of the company."},"status":{"type":"string","description":"Status of the company."}}}}},"input":{"type":"object","description":"Input details used for the search.","properties":{"paymentIdentity":{"type":"object","description":"Payment identity details provided in the input.","properties":{"iban":{"type":"string","description":"IBAN provided in the input."}}},"company":{"type":"object","description":"Company details provided in the input.","properties":{"registrationId":{"type":"string","description":"Registration ID of the input company."},"countryCode":{"type":"string","description":"Country code of the input company."}}}}},"reasons":{"type":"array","items":{"type":"string"},"description":"List of reason codes for the result."},"sepamailVerificationStatus":{"type":"string","description":"Status of the SepaMail verification."},"reasonLabels":{"type":"object","additionalProperties":{"type":"string"},"description":"Labels describing the reasons for the result."},"lastMatchVerificationDetail":{"type":"object","description":"Details about the last match verification.","properties":{"status":{"type":"string","description":"Status of the verification."},"date":{"type":"string","format":"date-time","description":"Timestamp of the verification."},"additionalData":{"type":"object","description":"Additional data related to the verification."}}}}}},"components/schemas/BankMatchIBANCompanySearchCriteria":{"id":"components/schemas/BankMatchIBANCompanySearchCriteria","kind":"json-schema","title":"BankMatchIBANCompanySearchCriteria","data":{"type":"object","description":"Criteria for searching a company using IBAN in the bank matching system.","properties":{"correlationId":{"type":"string","description":"Unique identifier for the request."},"criteriaSets":{"type":"array","description":"A list of criteria sets for matching a company.","items":{"type":"object","properties":{"regNo":{"type":"object","properties":{"required":{"type":"boolean","description":"Indicates if registration number is required."}}},"iban":{"type":"object","properties":{"validationRegExp":{"type":"string","description":"Regular expression for IBAN validation."},"required":{"type":"boolean","description":"Indicates if IBAN is required."}}}}}},"country":{"type":"string","description":"The country code where the search criteria applies (e.g., \"AE\")."}}}},"components/schemas/BankMatchIBANPersonSearch":{"id":"components/schemas/BankMatchIBANPersonSearch","kind":"json-schema","title":"BankMatchIBANPersonSearch","data":{"type":"object","description":"Response object for IBAN person search in bank matching.","properties":{"id":{"type":"string","description":"Unique identifier for the bank match search."},"classification":{"type":"string","description":"Classification result of the search (e.g., 'NO')."},"status":{"type":"string","description":"Status of the search process (e.g., 'SUCCEEDED')."},"entity":{"type":"object","description":"Contains details about the entity associated with the IBAN.","properties":{"paymentIdentity":{"type":"object","properties":{"id":{"type":"string","description":"The payment identity ID."},"iban":{"type":"string","description":"International Bank Account Number (IBAN)."},"type":{"type":"string","description":"Type of payment identity (e.g., 'IBAN')."}}},"company":{"type":"object","properties":{"legalPerson":{"type":"boolean","description":"Indicates if the entity is a legal person."},"representativeFirstName":{"type":"string","description":"First name of the company representative."},"representativeLastName":{"type":"string","description":"Last name of the company representative."},"countryCode":{"type":"string","description":"Country code of the company."}}}}},"input":{"type":"object","description":"Input details used for the search.","properties":{"paymentIdentity":{"type":"object","description":"Payment identity details provided in the input.","properties":{"iban":{"type":"string","description":"IBAN provided in the input."}}},"physicalPersonIdentifier":{"type":"object","description":"Physical person details provided in the input.","properties":{"firstName":{"type":"string","description":"First name of the person."},"lastName":{"type":"string","description":"Last name of the person."},"countryCode":{"type":"string","description":"Country code of the person."}}}}},"reasons":{"type":"array","items":{"type":"string"},"description":"List of reason codes for the result."},"sepamailVerificationStatus":{"type":"string","description":"Status of the SepaMail verification."},"reasonLabels":{"type":"object","additionalProperties":{"type":"string"},"description":"Labels describing the reasons for the result."},"lastMatchVerificationDetail":{"type":"object","description":"Details about the last match verification.","properties":{"status":{"type":"string","description":"Status of the verification."},"date":{"type":"string","format":"date-time","description":"Timestamp of the verification."},"additionalData":{"type":"object","description":"Additional data related to the verification."}}}}}},"components/schemas/BankMatchIBANPersonSearchAcceptedResponse":{"id":"components/schemas/BankMatchIBANPersonSearchAcceptedResponse","kind":"json-schema","title":"BankMatchIBANPersonSearchAcceptedResponse","data":{"type":"object","properties":{"correlationId":{"type":"string","format":"uuid","example":"78ba8a1a-a614-4d7a-bcc3-ea682cd6b510"},"checkId":{"type":"string","format":"uuid","example":"6889c5ef-8975-0f4f-c832-26cd6889c5ef"},"message":{"type":"string","example":"The bank details are currently being verified. You can track the progress of this request on the /localSolutions/FR/bankmatch/audition?audition_id={audition_id} endpoint."}}}},"components/schemas/BankMatchIBANPersonSearchCriteria":{"id":"components/schemas/BankMatchIBANPersonSearchCriteria","kind":"json-schema","title":"BankMatchIBANPersonSearchCriteria","data":{"type":"object","description":"Criteria for searching a person using IBAN in the bank matching system.","properties":{"bankCountry":{"type":"string","description":"The country code where the search criteria applies (e.g., \"FR\")."},"languages":{"type":"array","description":"List of supported language codes for the country.","items":{"type":"string"}},"criteriaSets":{"type":"array","description":"A list of criteria sets for matching a person.","items":{"type":"object","properties":{"firstName":{"type":"string","description":"indicates the first name is supported in the search criteria."},"lastName":{"type":"string","description":"indicates the last name is supported in the search criteria."},"birthDate":{"type":"string","description":"indicates the birth date is supported in the search criteria."},"iban":{"type":"string","description":"specifies the IBAN details and validation rules for the search."}}}}}}},"components/schemas/ComplianceCountryRiskResponse":{"id":"components/schemas/ComplianceCountryRiskResponse","kind":"json-schema","title":"ComplianceCountryRiskResponse","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Country risk response for a single country. Nullable fields are shown in this schema for completeness, but fields that evaluate to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" may be omitted from runtime API responses."},"children":[]}]}]}],"properties":{"correlationId":{"type":"string","format":"uuid","description":"Correlation ID for request tracing."},"country":{"type":"object","description":"Country identity and regional metadata.","properties":{"region":{"type":"string","description":"The region of the country."},"countryName":{"type":"string","description":"The name of the country."},"countryCodeIso2":{"type":"string","description":"The ISO 2 code of the country."},"countryCodeIso3":{"type":"string","description":"The ISO 3 code of the country."}},"required":["countryCodeIso3","countryCodeIso2","countryName","region"]},"risk":{"type":"object","description":"Country risk indicators returned by the service. Nullable indicator fields are included in the schema model, but may be omitted from runtime responses when no value is available.","properties":{"oecdMember":{"type":"boolean","description":"The OECD member status of the country."},"worldBankClassification":{"type":"string","description":"The World Bank classification of the country."},"countryRiskIndicatorAml":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains AML (Anti-Money Laundering) risk metrics for the country.  Includes the AML risk score (0–100), categorical risk classification,  global ranking, and data‑quality indicators. Values reflect inherent AML  exposure and the strength of regulatory and enforcement frameworks."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Scores and rankings are provided only where sufficient underlying AML data is  available."},"children":[]}]}]}],"properties":{"countryRank":{"type":["integer","null"],"description":"Global ranking where 1 indicates the lowest risk."},"countryUniverse":{"type":["integer","null"],"description":"Total number of countries included in this ranking model."},"dataQualityCategorical":{"type":["string","null"],"description":"Categorical data quality label.","enum":["Very Good","Good","Medium","Poor","Very Poor","Not Available",null]},"dataQualityNumeric":{"type":["integer","null"],"description":"Numeric representation of data quality (1 best, 5 worst)."},"euHighRiskFlag":{"type":["boolean","null"],"description":"Indicates whether the country is on the EU high-risk third-country list."},"fatfHighRisk":{"type":["boolean","null"],"description":"Indicates FATF high-risk jurisdiction status (black list)."},"fatfIncreasedMonitoring":{"type":["boolean","null"],"description":"Indicates FATF increased monitoring status (grey list)."},"riskClassificationCategorical":{"type":["string","null"],"description":"Categorical risk band.","enum":["Very Low","Low","Medium","High","Very High",null]},"riskClassificationNumeric":{"type":["integer","null"],"description":"Numeric representation of risk classification."},"score":{"type":["number","null"],"format":"float","description":"Risk score on a 0 to 100 scale."}}},"countryRiskIndicatorEsg":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains ESG (Environmental, Social, and Governance) risk metrics for the  country. Includes ESG score, categorical risk classification, global ranking,  and data‑quality indicators."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Scores and rankings are provided only where sufficient underlying ESG data is available."},"children":[]}]}]}],"properties":{"countryRank":{"type":["integer","null"],"description":"Global ranking where 1 indicates the lowest ESG risk."},"countryUniverse":{"type":["integer","null"],"description":"Total number of countries included in this ranking model."},"dataQualityCategorical":{"type":["string","null"],"description":"Categorical data quality label.","enum":["Very Good","Good","Medium","Poor","Very Poor","Not Available",null]},"dataQualityNumeric":{"type":["integer","null"],"description":"Numeric representation of data quality (1 best, 5 worst)."},"riskClassificationCategorical":{"type":["string","null"],"description":"Categorical ESG risk band.","enum":["Very Low","Low","Medium","High","Very High",null]},"riskClassificationNumeric":{"type":["integer","null"],"description":"Numeric representation of ESG risk classification."},"score":{"type":["number","null"],"format":"float","description":"ESG score on a 0 to 100 scale."}}},"countryRiskIndicatorSovereign":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains sovereign‑risk metrics assessing a country’s economic and financial  stability and its ability to meet debt obligations. Includes sovereign risk  score, categorical classification, global ranking, and data‑quality measures."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Scores and rankings are provided only where sufficient underlying sovereign  data is available."},"children":[]}]}]}],"properties":{"countryRank":{"type":["integer","null"],"description":"Global ranking where 1 indicates the lowest sovereign risk."},"countryUniverse":{"type":["integer","null"],"description":"Total number of countries included in this ranking model."},"dataQualityCategorical":{"type":["string","null"],"description":"Categorical data quality label.","enum":["Very Good","Good","Medium","Poor","Very Poor","Not Available",null]},"dataQualityNumeric":{"type":["integer","null"],"description":"Numeric representation of data quality (1 best, 5 worst)."},"riskClassificationCategorical":{"type":["string","null"],"description":"Categorical sovereign risk band.","enum":["Very Low","Low","Medium","High","Very High",null]},"riskClassificationNumeric":{"type":["integer","null"],"description":"Numeric representation of sovereign risk classification."},"score":{"type":["number","null"],"format":"float","description":"Sovereign score on a 0 to 100 scale."}}},"countryRiskIndicatorSupplyChainRisk":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains supply‑chain‑related country‑risk metrics, including the overall  supply chain risk score, categorical classification, global ranking, and  data‑quality indicators. The score reflects exposure to vulnerabilities such  as governance, environmental conditions, and labour‑related risks."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Scores and rankings are provided only where sufficient underlying supply chain data  is available."},"children":[]}]}]}],"properties":{"countryRank":{"type":["integer","null"],"description":"Global ranking where 1 indicates the lowest supply chain risk."},"countryUniverse":{"type":["integer","null"],"description":"Total number of countries included in this ranking model."},"dataQualityCategorical":{"type":["string","null"],"description":"Categorical data quality label.","enum":["Very Good","Good","Medium","Poor","Very Poor","Not Available",null]},"dataQualityNumeric":{"type":["integer","null"],"description":"Numeric representation of data quality (1 best, 5 worst)."},"riskClassificationCategorical":{"type":["string","null"],"description":"Categorical supply chain risk band.","enum":["Very Low","Low","Medium","High","Very High",null]},"riskClassificationNumeric":{"type":["integer","null"],"description":"Numeric representation of supply chain risk classification."},"score":{"type":["number","null"],"format":"float","description":"Supply chain risk score on a 0 to 100 scale."}}}},"required":["oecdMember","worldBankClassification"]}},"required":["correlationId","country","risk"],"example":{"correlationId":"f563b6bc-549f-4d4a-95bc-c658b407bd2f","country":{"countryCodeIso3":"MAF","countryCodeIso2":"MF","countryName":"Saint Martin (French part)","region":"Americas"},"risk":{"oecdMember":false,"worldBankClassification":"High income","countryRiskIndicatorAml":{"countryRank":154,"countryUniverse":249,"dataQualityCategorical":"Poor","dataQualityNumeric":2,"euHighRiskFlag":false,"fatfHighRisk":false,"fatfIncreasedMonitoring":false,"riskClassificationCategorical":"High","riskClassificationNumeric":4,"score":42.86},"countryRiskIndicatorEsg":{"dataQualityCategorical":"Very Poor","countryUniverse":186,"dataQualityNumeric":1,"riskClassificationCategorical":null,"score":null,"countryRank":null,"riskClassificationNumeric":null},"countryRiskIndicatorSovereign":{"dataQualityCategorical":"Very Poor","dataQualityNumeric":1,"countryUniverse":184,"riskClassificationCategorical":null,"score":null,"countryRank":null,"riskClassificationNumeric":null},"countryRiskIndicatorSupplyChainRisk":{"dataQualityCategorical":"Very Poor","riskClassificationCategorical":"Very Low","score":12.63,"countryRank":18,"countryUniverse":233,"dataQualityNumeric":1,"riskClassificationNumeric":1}}}}},"components/schemas/GetKycProtectAsyncAmlJobItemResponse":{"id":"components/schemas/GetKycProtectAsyncAmlJobItemResponse","kind":"json-schema","title":"GetKycProtectAsyncAmlJobItemResponse","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["created","processing","completed"]},"createdAt":{"type":"string","format":"date-time"},"createdById":{"type":"integer","format":"int32"},"createdBy":{"type":"string"},"startedAt":{"type":["string","null"],"format":"date-time"},"finishedAt":{"type":["string","null"],"format":"date-time"},"criteriaCount":{"type":"integer","format":"int32"}}}},"components/schemas/GetKycProtectAsyncAmlJobResponse":{"id":"components/schemas/GetKycProtectAsyncAmlJobResponse","kind":"json-schema","title":"GetKycProtectAsyncAmlJobResponse","data":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/GetKycProtectAsyncAmlJobItemResponse"}},"totalSize":{"description":"Total number of items available.","type":"integer"},"correlationId":{"description":"Correlation ID for tracking the request.","type":"string"}}}},"components/schemas/KycProtectAsyncJobCriteriaResponse":{"id":"components/schemas/KycProtectAsyncJobCriteriaResponse","kind":"json-schema","title":"KycProtectAsyncJobCriteriaResponse","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"jobId":{"type":"string","format":"uuid"},"status":{"enum":["submitted","processing","completed","failed"],"type":"string"},"errorMessage":{"type":["string","null"]},"targetType":{"enum":["profile","keyParty"],"type":"string"},"targetId":{"type":"string","format":"uuid"},"type":{"enum":["individual","business"],"type":"string"},"startedAt":{"type":["string","null"],"format":"date-time"},"finishedAt":{"type":["string","null"],"format":"date-time"},"countryCodes":{"type":"array","items":{"type":["string","null"]}},"threshold":{"type":"integer","format":"int32"},"name":{"type":["string","null"]},"firstName":{"type":["string","null"]},"middleName":{"type":["string","null"]},"lastName":{"type":["string","null"]},"dateOfBirth":{"type":["string","null"],"description":"Can be in the format YYYY or YYYY-MM-DD","format":"date"},"gender":{"enum":["male","female"],"type":["string","null"]},"pepTiers":{"type":"array","items":{"type":["string","null"],"enum":["pepTier1","pepTier2","pepTier3"]}},"datasets":{"type":"array","items":{"type":"string"}},"sanctionBodies":{"type":["array","null"],"items":{"type":"integer"},"description":"Provided sanctionBodies for the search"},"isDobRequired":{"type":["boolean","null"],"description":"Indicates whether date of birth is required for the individual search."}}}},"components/schemas/GetKycProtectAsyncAmlJobCriteriaResponse":{"id":"components/schemas/GetKycProtectAsyncAmlJobCriteriaResponse","kind":"json-schema","title":"GetKycProtectAsyncAmlJobCriteriaResponse","data":{"type":"object","properties":{"items":{"type":"array","description":"List of KYC Protect async AML job criteria responses.","items":{"$ref":"#/components/schemas/KycProtectAsyncJobCriteriaResponse"}},"totalSize":{"type":"integer","format":"int64","description":"Total number of items available."},"correlationId":{"type":"string","description":"Correlation ID for tracking the request."}}}},"components/schemas/GetAuditsResponse":{"id":"components/schemas/GetAuditsResponse","kind":"json-schema","title":"GetAuditsResponse","data":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Id of the Audit","format":"uuid"},"description":{"type":"string","description":"Description of the Audit"},"category":{"enum":["profile","amlSearch"],"type":"string","description":"Category of the audit"},"subcategory":{"enum":["profileDetails","keyParty","amlMonitoring"],"type":"string","description":"Subcategory of the audit"},"action":{"enum":["created","updated","deleted","searchRemoved","searchLinked","attachmentCreated","attachmentUpdated","attachmentDeleted","noteCreated","noteUpdated","noteDeleted","noteArchived","noteUnarchived","addressCreated","addressUpdated","addressDeleted","kycStatusUpdated","addedToAmlMonitoring","updatedInAmlMonitoring","removedFromAmlMonitoring"],"type":"string","description":"Action of the audit"},"createdAt":{"type":"string","description":"Audit created date and time","format":"date-time"},"createdById":{"type":"integer","description":"Id of the user who created the audit","format":"int32"},"createdBy":{"type":"string","description":"Name of the user who created the audit"},"payload":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payload"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property represents the state of involved entities at the time of action taking place."},"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 property contains dynamic data that varies depending on the request parameters and the context of the request. The response and can differ even with the same parameters under different conditions or contexts."},"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 means the content of this property is not fixed and can include various data types such as GUIDs, strings, integers, and complex objects."},"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":" Due to its dynamic nature, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payload"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can include any of the following potential structures, but is not limited to these examples  "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" A single key-value pair where thecvalue is a string or number. "},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" A nested object containing detailed data structures. "},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" An array of objects each with different attributes."},"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":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Consumers of this API should handle the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payload"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" dynamically and be prepared to encounter different data types and structures."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Detailed processing logic based on the specific application needs and context checks is recommended when utilising this field."},"children":[]}]}]}],"additionalProperties":true,"example":{"companyId":"GB-0-0123456789","profileId":"12345f68-1234-1234-1a2b-1a12bb4c578","safeNumber":"UK0122345678","profileName":"Example Profile"}}},"additionalProperties":false,"description":"Represents a response object for audits."}},"totalSize":{"type":"integer","description":"Total number of audits"},"correlationId":{"description":"Correlation Id for the request","type":"string"}}}},"components/schemas/GetKycProtectBatchUploadsByUploadIdItemResponse":{"id":"components/schemas/GetKycProtectBatchUploadsByUploadIdItemResponse","kind":"json-schema","title":"GetKycProtectBatchUploadsByUploadIdItemResponse","data":{"description":"Model for batch upload response","type":"object","additionalProperties":false,"properties":{"id":{"type":"string","description":"Batch upload request Id","format":"uuid"},"filename":{"type":"string","description":"User given file name"},"status":{"enum":["submitted","validating","rejected","validated","insufficientCredits","queued","inProgress","processed","completed","partiallyCompleted","failed"],"type":"string","description":"Batch upload status"},"rowCount":{"type":"integer","description":"Batch upload file record count","format":"int32"},"successCount":{"type":"integer","description":"Successful record count in batch upload file","format":"int32"},"uploadedAt":{"type":"string","description":"Batch upload requested timestamp","format":"date-time"},"uploadedById":{"type":"integer","description":"Batch upload requested by user id","format":"int32"},"uploadedBy":{"type":"string","description":"Batch file uploaded by user"},"completedAt":{"type":["string","null"],"description":"Batch upload completed timestamp","format":"date-time"}}}},"components/schemas/GetKycProtectBatchUploadsByUploadsResponse":{"id":"components/schemas/GetKycProtectBatchUploadsByUploadsResponse","kind":"json-schema","title":"GetKycProtectBatchUploadsByUploadsResponse","data":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/GetKycProtectBatchUploadsByUploadIdItemResponse"}},"totalSize":{"type":"integer"}}}},"components/schemas/PostKycProtectBatchUploadsRequest":{"id":"components/schemas/PostKycProtectBatchUploadsRequest","kind":"json-schema","title":"PostKycProtectBatchUploadsRequest","data":{"type":"object","required":["File"],"properties":{"File":{"type":"string","description":"The batch file to be processed. Size Limited to 10MB","format":"binary"}}}},"components/schemas/GetBatchUploadsDownloadErrorsByUploadIdResponse":{"id":"components/schemas/GetBatchUploadsDownloadErrorsByUploadIdResponse","kind":"json-schema","title":"GetBatchUploadsDownloadErrorsByUploadIdResponse","data":{"type":"object","properties":{"downloadUrl":{"type":"string","description":"Url of the file to download"},"fileName":{"type":"string","description":"Name of the file"},"expiresAt":{"type":"string","description":"Date and time when the url will expire","format":"date-time"}}}},"components/schemas/PutBatchUploadsRetryByIdResponse":{"id":"components/schemas/PutBatchUploadsRetryByIdResponse","kind":"json-schema","title":"PutBatchUploadsRetryByIdResponse","data":{"type":"object","properties":{"id":{"type":"string","description":"Batch upload request Id","format":"uuid"},"filename":{"type":"string","description":"User given file name"},"status":{"type":"string","description":"Batch upload status (submitted, validating, rejected, validated, insufficientCredits, queued, inProgress, processed, completed, partiallyCompleted, failed)"},"rowCount":{"type":"integer","description":"Batch upload file record count","format":"int32"},"successCount":{"type":"integer","description":"Successful record count in batch upload file","format":"int32"},"uploadedAt":{"type":"string","description":"Batch upload requested timestamp","format":"date-time"},"uploadedById":{"type":"integer","description":"Batch upload requested by user id","format":"int32"},"uploadedBy":{"type":"string","description":"Batch file uploaded by user"},"completedAt":{"type":["string","null"],"description":"Batch upload completed timestamp","format":"date-time"}}}},"components/schemas/GetBatchUploadsTemplateResponse":{"id":"components/schemas/GetBatchUploadsTemplateResponse","kind":"json-schema","title":"GetBatchUploadsTemplateResponse","data":{"type":"object","properties":{"downloadUrl":{"type":"string","description":"Url of the file to download"},"fileName":{"type":"string","description":"Name of the file"},"expiresAt":{"type":"string","description":"Date and time when the url will expire","format":"date-time"},"correlationId":{"type":"string","description":"Unique GUID for the specific request"}}}},"components/schemas/GetKycProtectAlertResponse":{"id":"components/schemas/GetKycProtectAlertResponse","kind":"json-schema","title":"GetKycProtectAlertResponse","data":{"type":"object","properties":{"safeNumber":{"type":"string","description":"Safe number of the company or entity."},"name":{"type":"string","description":"Name of the company or entity."},"countryCode":{"type":"string","description":"Two-letter ISO country code."},"entities":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Entities associated with the alert, grouped by property."},"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":" Any properties with no available data are excluded from the response."},"children":[]}]}]}],"properties":{"currentDirectors":{"type":"array","description":"directors detail related to the alert.","items":{"type":"object","properties":{"type":{"type":"string","description":"Type of the entity (e.g., individual, business)."},"name":{"type":"string","description":"Full name of the entity."},"firstName":{"type":"string","description":"First name of the entity (if individual)."},"middleName":{"type":"string","description":"Middle name of the entity (if individual)."},"lastName":{"type":"string","description":"Last name of the entity (if individual)."},"countryCode":{"type":"string","description":"Country code of the entity."},"gender":{"type":"string","description":"Gender of the entity (if individual)."},"dateOfBirth":{"type":"string","format":"date","description":"Date of birth details for the entity."},"hasAlerts":{"type":"boolean","description":"Indicates if the entity has alerts."}}}},"ubos":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ultimate Beneficial Owners (UBOs) detail related to the alert."},"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":" If the UBO type is 'business', the properties firstName, middleName, lastName, gender, and dateOfBirth are omitted."},"children":[]}]}]}],"items":{"type":"object","properties":{"type":{"type":"string","description":"Type of the entity (e.g., individual, business)."},"name":{"type":"string","description":"Full name of the entity."},"firstName":{"type":"string","description":"First name of the entity (if individual)."},"middleName":{"type":"string","description":"Middle name of the entity (if individual)."},"lastName":{"type":"string","description":"Last name of the entity (if individual)."},"countryCode":{"type":"string","description":"Country code of the entity."},"gender":{"type":"string","description":"Gender of the entity (if individual)."},"dateOfBirth":{"type":"string","format":"date","description":"Date of birth details for the entity."},"hasAlerts":{"type":"boolean","description":"Indicates if the entity has alerts."}}}}}},"hasAlerts":{"type":"boolean","description":"Indicates if there are any alerts for the response."},"entitiesWithAlerts":{"type":"number","description":"Number of entities with alerts."},"lastUpdated":{"type":"string","format":"date-time","description":"Timestamp of the last update."}}}},"components/schemas/DeleteKYCMonitoringProfilesResquest":{"id":"components/schemas/DeleteKYCMonitoringProfilesResquest","kind":"json-schema","title":"DeleteKYCMonitoringProfilesResquest","data":{"type":"object","properties":{"items":{"type":["array","null"],"items":{"type":"string","format":"uuid"},"description":"The Request Items collection"}}}},"components/schemas/DeleteKYCMonitoringProfilesResponse":{"id":"components/schemas/DeleteKYCMonitoringProfilesResponse","kind":"json-schema","title":"DeleteKYCMonitoringProfilesResponse","data":{"type":"object","properties":{"failed":{"type":["array","null"],"items":{"type":"object","properties":{"failedItem":{"type":"string","format":"uuid"},"error":{"type":"object","properties":{"type":{"type":["string","null"]},"title":{"type":["string","null"]},"status":{"type":["integer","null"],"format":"int32"},"detail":{"type":["string","null"]},"instance":{"type":["string","null"]}}}}}},"successful":{"type":["array","null"],"items":{"type":"string","format":"uuid"}}}}},"components/schemas/KycMonitoringKycAlertResponse":{"id":"components/schemas/KycMonitoringKycAlertResponse","kind":"json-schema","title":"KycMonitoringKycAlertResponse","data":{"type":"object","properties":{"id":{"type":"string","description":"Id of the kyc alert","format":"uuid"},"profileId":{"type":"string","description":"Id of the profile","format":"uuid"},"safeNumber":{"description":"Safe number of the profile","type":["string","null"]},"companyId":{"type":["string","null"],"description":"Company id of the profile"},"previousValue":{"type":["string","null"],"description":"Previous value from the kyc alert"},"newValue":{"type":["string","null"],"description":"New value from the kyc alert"},"ruleName":{"type":["string","null"],"description":"Rule name from the kyc alert"},"eventAt":{"type":"string","description":"Date of the kyc alert when it got created","format":"date-time"},"status":{"type":"string","description":"Status of kyc alert, open, closedProcessed, closedUnprocessed"},"note":{"type":"string","description":"Note of kyc alert"},"createdAt":{"type":"string","description":"Kyc alert created time","format":"date-time"},"createdById":{"type":"integer","description":"Id of the user who created the kyc alert","format":"int32"},"createdBy":{"type":"string","description":"Name of the user who created the kyc alert"},"modifiedAt":{"type":["string","null"],"description":"kyc alert last updated time","format":"date-time"},"modifiedById":{"description":"Id of the user who last modified the kyc alert","format":"int32","type":["integer","null"]},"modifiedBy":{"type":["string","null"],"description":"Name of the user who last modified the kyc alert"}}}},"components/schemas/UpdateKycAlertContract":{"id":"components/schemas/UpdateKycAlertContract","kind":"json-schema","title":"UpdateKycAlertContract","data":{"type":"object","properties":{"note":{"type":["string","null"],"description":"Note of kyc alert"},"status":{"type":["string","null"],"description":"Status of kyc alert. Allowed values are open, closedProcessed, closedUnprocessed"}}}},"components/schemas/PostKYCMonitoringProfilesBulkResquest":{"id":"components/schemas/PostKYCMonitoringProfilesBulkResquest","kind":"json-schema","title":"PostKYCMonitoringProfilesBulkResquest","data":{"type":"object","properties":{"items":{"type":["array","null"],"items":{"type":"string","format":"uuid"},"description":"Provide the list of profile Id's in the array."}}}},"components/schemas/PostKYCMonitoringProfilesBulkResponse":{"id":"components/schemas/PostKYCMonitoringProfilesBulkResponse","kind":"json-schema","title":"PostKYCMonitoringProfilesBulkResponse","data":{"type":"object","properties":{"failed":{"type":["array","null"],"items":{"type":"object","properties":{"failedItem":{"type":"string","format":"uuid","description":"Provides a list of failed profiles"},"error":{"type":"object","description":"Expanded detail about the error on the listed profile","properties":{"type":{"type":["string","null"]},"title":{"type":["string","null"]},"status":{"type":["integer","null"],"format":"int32"},"detail":{"type":["string","null"]},"instance":{"type":["string","null"]}}}}}},"successful":{"type":["array","null"],"items":{"type":"string","format":"uuid","description":"Provides a list of the profiles that have successfully been uploaded"}}}}},"components/schemas/KycProtectGetSanctionBodyDetailsResponse":{"id":"components/schemas/KycProtectGetSanctionBodyDetailsResponse","kind":"json-schema","title":"KycProtectGetSanctionBodyDetailsResponse","data":{"type":"object","properties":{"data":{"type":"array","description":"Array of sanction body details available for AML screening and monitoring.","items":{"type":"object","properties":{"id":{"type":"integer","format":"int32","description":"The unique identifier for the sanction body."},"name":{"type":"string","description":"The name of the sanction body or sanctioning authority."},"region":{"type":"string","enum":["eas","ecs","lcn","mea","nac","sas","ssf","glb"],"description":"The regional classification of the sanction body. Valid values are eas, ecs, lcn, mea, nac, sas, ssf, glb."}}}},"correlationId":{"type":"string","description":"A unique ID assigned to this request for tracking and troubleshooting purposes."}}}},"components/schemas/GetKYCProfiles":{"id":"components/schemas/GetKYCProfiles","kind":"json-schema","title":"GetKYCProfiles","data":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Id of the Profile"},"name":{"type":"string","description":"Name of the Profile"},"riskRating":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Risk rating given to profile Available values [notApplicable, veryLow, low, medium, high, veryHigh]"},"children":[]}]}]}]},"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 profile - Available value [new, approved, declined, pending, cancelled, referred, closed, approvedReviewDue]"},"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 profile Available values [trust, individual, soleTrader, company, plc, partnership, otherEntity]"},"children":[]}]}]}]},"internalId":{"type":"string","description":"Internal Id given to profile by customer"},"assignedToId":{"type":"integer","description":"Id of the user assigned to the profile"},"assignedTo":{"type":"string","description":"Name of the user assigned to the profile"},"safeNumber":{"type":"string","description":"safe number of the business linked to the profile"},"companyId":{"type":"string","description":"company id of the business linked to the profile"},"formationDate":{"type":"string","description":"Formation date of the business linked to the profile","format":"date"},"createdAt":{"type":"string","description":"Profile created time","format":"date-time"},"createdById":{"type":"integer","description":"Id of the user who created the profile","format":"int32"},"createdBy":{"type":"string","description":"Name of the user who created the profile"},"modifiedAt":{"type":"string","description":"Profile last updated time","format":"date-time"},"modifiedById":{"type":"integer","description":"Id of the user who last modified the profile","format":"int32"},"modifiedBy":{"type":"string","description":"Name of the user who last modified the profile"},"kycApprovedAt":{"type":"string","description":"Date when the profile got approved","format":"date-time"},"kycReviewOn":{"type":"string","description":"Date when profile is to be reviewed","format":"date"},"kycStatusUpdatedOn":{"type":"string","description":"Date when the profile status was last updated","format":"date-time"},"kycComments":{"type":"string","description":"Profile comments"},"noteCount":{"type":"integer","description":"Count of notes associated with profile","format":"int32"},"attachmentCount":{"type":"integer","description":"Count of attachments associated with profile","format":"int32"},"keyPartyCount":{"type":"integer","description":"Count of key parties associated with profile","format":"int32"},"uboCount":{"type":"integer","description":"Count of UBOs associated with profile","format":"int32"},"openAlertCount":{"type":"integer","description":"Count of Open Alerts","format":"int32"},"modeOfCreation":{"type":"string","description":"Mode of profile creation (manual, import)"},"importStatus":{"type":["string","null"],"deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of profile creation (submitted, preprocessed,\\ \\ validated, queued, inProgress, processed, completed, partiallyCompleted,\\ \\ failed)"},"children":[]}]}]}]},"isLocked":{"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 profile is locked during data import processes.  When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the profile is unlocked and all import processes have completed. Use this property rather than "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"importStatus"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to determine if data importing has finished."},"children":[]}]}]}]}}}},"totalSize":{"type":"number"},"correlationId":{"type":"string","description":"A unique ID assigned to this request."}}}},"components/schemas/KycProtectPostProfilesRequest":{"id":"components/schemas/KycProtectPostProfilesRequest","kind":"json-schema","title":"KycProtectPostProfilesRequest","data":{"type":"object","required":["name","type"],"properties":{"name":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the profile being created."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This MUST be unique across your profiles."},"children":[]}]}]}],"type":["string","null"]},"type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The profile type to be created. This will effect searches later for validations."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" i.e. Not being able to apply certain datasets (Example - State Owned Enterprises) to an Individual profile. Ensure the correct type is applied for intended search."},"children":[]}]}]}],"type":["string","null"],"enum":["trust","individual","soleTrader","company","plc","partnership","otherEntity"],"example":"trust"},"internalId":{"description":"Internal ID of the profile, this MUST be unique across your profiles.","type":["string","null"]},"assignedToId":{"description":"Creditsafe Id of the user to assign the profile to.","type":["integer","null"]},"kycReviewOn":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date to which the profile should be reviewed. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Format YYYY-MM-DD "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Validates when the date changes and is either current or in the future."},"children":[]}]}]}],"type":["string","null"]},"status":{"description":"Status of the profile.","type":["string","null"],"enum":["new","approved","declined","pending","cancelled","referred","closed","approvedReviewDue"]},"riskRating":{"description":"Risk rating of the profile.","type":["string","null"],"enum":["notApplicable","veryLow","low","medium","high","veryHigh"]},"kycComments":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Free text field for users to highlight key information to other users. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Maximum characters allowed is 250"},"children":[]}]}]}],"type":["string","null"]},"details":{"type":"object","description":"Please note the required property in this object.","required":["legalName"],"properties":{"legalName":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name of the Business or Individual"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Maximum length is 150 characters"},"children":[]}]}]}],"example":"Creditsafe Ltd"},"tradingName":{"type":["string","null"],"example":null,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid for profile type - SoleTrader"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Maximum length is 150 characters"},"children":[]}]}]}]},"aliases":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name of any Aliases"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Maximum length of each alias is 150 characters"},"children":[]}]}]}],"example":null},"activity":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Activity of the Business e.g. NAIC S/SIC Codes"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Valid for profile types - Trust, Company, Partnership, OtherEntity and PLC"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Maximum length of activity is 150 characters"},"children":[]}]}]}],"example":"62409"},"description":{"type":["string","null"],"example":"Example Free Text","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description of the business/individual entity"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Valid for the profile types Trust, Company, Partnership, OtherEntity and PLC"},"children":[]}]}]}]},"contactName":{"type":["string","null"],"description":"Contact person at the organisation.","example":null},"email":{"type":["string","null"],"description":"Contact email address of the entity","example":"example@creditsafe.com"},"website":{"type":["string","null"],"example":"www.creditsafe.com","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Website address of the entity"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Valid for the profile types Trust, Company, Partnership, OtherEntity and PLC"},"children":[]}]}]}]},"telephone":{"type":["string","null"],"example":null,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Telephone number of the entity."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Valid for the profile types Trust, Company, Partnership, OtherEntity and PLC"},"children":[]}]}]}]},"turnover":{"type":"object","properties":{"currencyCode":{"type":["string","null"],"description":"The currency the amount is in","enum":["eur","gbp","usd","cny","cad","aud","nzd","inr","jpy","chf","zar","dkk","sek","nok"]},"amount":{"description":"Total Turnover Figure","type":["integer","null"]}}},"assetsUnderManagement":{"type":"object","properties":{"currencyCode":{"type":["string","null"],"description":"The currency the amount is in","enum":["eur","gbp","usd","cny","cad","aud","nzd","inr","jpy","chf","zar","dkk","sek","nok"]},"amount":{"type":["integer","null"],"description":"The total value of the assets under management"}}},"organizationNumber":{"type":["string","null"],"description":"Property valid for profile type - Trust, Company, Partnership, OtherEntity and PLC","example":"12345678"},"internalContact":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal contact name to contact regarding this profile,"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Property valid for profile type - Trust, Company, Partnership, OtherEntity and PLC."},"children":[]}]}]}],"example":null},"internalEmail":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal email address to contact regarding this profile."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Property valid for profile type - Trust, Company, Partnership, OtherEntity and PLC"},"children":[]}]}]}],"example":null},"dateOfBirth":{"type":["string","null"],"format":"date","example":"2024-03-25","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date YYYY-MM-DD or YYYY format. Must be after 1900 and not in the future"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Valid for the profile types Individual and SoleTrader"},"children":[]}]}]}]},"countryCode":{"type":["string","null"],"example":"GB","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Two-letter country code ISO-3166-2."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Valid for the profile types Individual and SoleTrader"},"children":[]}]}]}]},"vatNo":{"type":["string","null"],"example":"GB12345678","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tax Identification Number of the business"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Valid for the profile types Company, Partnership, OtherEntity and PLC"},"children":[]}]}]}]},"isListedOnExchange":{"type":["boolean","null"],"description":"Property valid for profile type PLC","example":null},"exchangeName":{"type":["string","null"],"description":"Property valid for profile type PLC","example":null}}}}}},"components/schemas/KycProtectProfileCreatedResponse":{"id":"components/schemas/KycProtectProfileCreatedResponse","kind":"json-schema","title":"KycProtectProfileCreatedResponse","data":{"type":"object","properties":{"id":{"type":"string","description":"Id of the Profile","format":"uuid"},"name":{"type":"string","description":"Name of the Profile"},"riskRating":{"type":"string","description":"Risk rating given to profile (notApplicable, veryLow, low, medium, high, veryHigh)"},"status":{"type":"string","description":"Status of the profile (new, approved, declined, pending, cancelled, referred, closed, approvedReviewDue)"},"type":{"type":"string","description":"Type of the profile (trust, individual, soleTrader, company, plc, partnership, otherEntity)"},"internalId":{"type":["string","null"],"description":"Internal Id given to profile by customer"},"assignedToId":{"type":["integer","null"],"description":"Id of the user assigned to the profile"},"assignedTo":{"type":["string","null"],"description":"Name of the user assigned to the profile"},"safeNumber":{"type":["string","null"],"description":"safe number of the business linked to the profile"},"companyId":{"type":["string","null"],"description":"company id of the business linked to the profile"},"formationDate":{"type":["string","null"],"description":"Formation date of the business linked to the profile","format":"date"},"createdAt":{"type":"string","description":"Profile created time","format":"date-time"},"createdById":{"type":"integer","description":"Id of the user who created the profile","format":"int32"},"createdBy":{"type":"string","description":"Name of the user who created the profile"},"modifiedAt":{"type":["string","null"],"description":"Profile last updated time","format":"date-time"},"modifiedById":{"type":["integer","null"],"description":"Id of the user who last modified the profile","format":"int32"},"modifiedBy":{"type":["string","null"],"description":"Name of the user who last modified the profile"},"kycApprovedAt":{"type":["string","null"],"description":"Date when the profile got approved","format":"date-time"},"kycReviewOn":{"type":["string","null"],"description":"Date when profile is to be reviewed","format":"date"},"kycStatusUpdatedOn":{"type":["string","null"],"description":"Date when the profile status was last updated","format":"date-time"},"kycComments":{"type":["string","null"],"description":"Profile comments"},"noteCount":{"type":"integer","description":"Count of notes associated with profile","format":"int32"},"attachmentCount":{"type":"integer","description":"Count of attachments associated with profile","format":"int32"},"keyPartyCount":{"type":"integer","description":"Count of key parties associated with profile","format":"int32"},"uboCount":{"type":"integer","description":"Count of UBOs associated with profile","format":"int32"},"openAlertCount":{"type":"integer","description":"Count of Open Alerts","format":"int32"},"modeOfCreation":{"type":"string","description":"Mode of profile creation (manual, import)"},"importStatus":{"type":["string","null"],"deprecated":true,"description":"Status of profile creation (submitted, preprocessed, validated, queued, inProgress, processed, completed, partiallyCompleted, failed)"},"isLocked":{"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 profile is locked during data import processes.  When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the profile is unlocked and all import processes have completed. Use this property rather than "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"importStatus"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to determine if data importing has finished."},"children":[]}]}]}]},"details":{"type":"object","properties":{"profileId":{"type":"string","description":"Id of the profile","format":"uuid"},"legalName":{"type":"string","description":"Name of the business/individual"},"tradingName":{"type":["string","null"],"description":"Trading name of the entity"},"aliases":{"type":"array","items":{"type":["string","null"]},"description":"Alias names given for the entity"},"activity":{"type":["string","null"],"description":"Activity of the business e.g., NAICS/SIC codes"},"description":{"type":["string","null"],"description":"Description of the entity"},"contactName":{"type":["string","null"],"description":"Contact person name"},"email":{"type":["string","null"],"description":"Contact email address"},"website":{"type":["string","null"],"description":"Entity website address"},"telephone":{"type":["string","null"],"description":"Contact telephone number"},"turnover":{"description":"Turnover","type":"object","properties":{"currencyCode":{"description":"Currency Code(eur, gbp, usd, cny, cad, aud, nzd, inr, jpy, chf, zar, dkk, sek, nok).","type":["string","null"]},"amount":{"description":"Turnover Amount.","type":["number","null"]}}},"assetsUnderManagement":{"description":"Assets Under Management","type":"object","properties":{"currencyCode":{"description":"Currency Code(eur, gbp, usd, cny, cad, aud, nzd, inr, jpy, chf, zar, dkk, sek, nok).","type":["string","null"]},"amount":{"description":"Assets Under Management Amount.","type":["number","null"]}}},"dateOfBirth":{"type":["string","null"],"description":"Date of birth of the individual","format":"date"},"countryCode":{"type":["string","null"],"description":"Two-letter country code ISO-3166-2"},"vatNo":{"type":["string","null"],"description":"Tax Identification Number of the business"},"isListedOnExchange":{"type":["boolean","null"],"description":"Details of company listed on exchange"},"exchangeName":{"type":["string","null"],"description":"Gets the name of the exchange."},"organizationNumber":{"type":["string","null"],"description":"Gets the organisation number."},"internalContact":{"type":["string","null"],"description":"Gets the internal contact."},"internalEmail":{"type":["string","null"],"description":"Gets the internal email."},"internationalScore":{"type":["string","null"],"description":"Gets the international score."},"createdAt":{"type":"string","description":"Profile details created time","format":"date-time"},"createdById":{"type":"integer","description":"Id of the user who created profile","format":"int32"},"createdBy":{"type":"string","description":"Name of the user who created profile"},"modifiedAt":{"type":["string","null"],"description":"Profile details last updated time","format":"date-time"},"modifiedById":{"type":["integer","null"],"description":"Id of the user who last modified the profile","format":"int32"},"modifiedBy":{"type":["string","null"],"description":"Name of the user who last modified the profile"},"noteCount":{"type":"integer","description":"Count of notes associated with profile details","format":"int32"},"attachmentCount":{"type":"integer","description":"Count of attachment associated with profile details","format":"int32"}}}}}},"components/schemas/DeleteKYCProfiles":{"id":"components/schemas/DeleteKYCProfiles","kind":"json-schema","title":"DeleteKYCProfiles","data":{"type":"array","items":{"type":"string","example":"fd91185f-c10e-4a42-b0b4-cc367371ebdb"}}},"components/schemas/GetKYCProfileByProfileId":{"id":"components/schemas/GetKYCProfileByProfileId","kind":"json-schema","title":"GetKYCProfileByProfileId","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Id of the profile assigned"},"name":{"type":"string","description":"The name of the profile"},"riskRating":{"type":"string","description":"The risk rating being assigned to the profile","enum":["notApplicable","veryLow","low","medium","high","veryHigh"]},"status":{"type":"string","description":"The current status of the profile","enum":["new","approved","declined","pending","cancelled","referred","closed","approvedReviewDue"]},"type":{"type":"string","description":"The type of the profile","enum":["trust","individual","soleTrader","company","plc","partnership","otherEntity"]},"internalId":{"type":["string","null"],"description":"The internal Id given to the profile by the customer"},"assignedToId":{"type":["integer","null"],"description":"Id of the user assigned to the profile"},"assignedTo":{"type":["string","null"],"description":"Name of the user assigned to the profile"},"safeNumber":{"type":["string","null"],"description":"The safe number linked to the profile"},"companyId":{"type":["string","null"],"description":"The companyID linked to the profile"},"formationDate":{"type":["string","null"],"format":"date","description":"Formation date of the business linked to the profile"},"createdAt":{"type":"string","format":"date-time","description":"The profile creating time"},"createdById":{"type":"integer","description":"Id of the user who created the profile"},"createdBy":{"type":"string","description":"Name of the user who created the profile"},"modifiedAt":{"type":["string","null"],"format":"date-time","description":"The time the profile was last updated"},"modifiedById":{"type":["integer","null"],"description":"Id of the user who last modified the profile"},"modifiedBy":{"type":["string","null"],"description":"Name of the user who last modified the profile"},"kycApprovedAt":{"type":["string","null"],"format":"date-time","description":"The date when the profile got approved at"},"kycReviewOn":{"type":["string","null"],"format":"date","description":"The date to which the profile is to be reviewed"},"kycStatusUpdatedOn":{"type":["string","null"],"format":"date-time","description":"Date when the profile status was last updated"},"kycComments":{"type":["string","null"],"description":"Profile comments"},"noteCount":{"type":"integer","description":"Count of the number of notes associated to the profile"},"attachmentCount":{"type":"integer","description":"Count of the number of attachments associated to the profile"},"keyPartyCount":{"type":"integer","description":"Count of the number of key parties associated to the profile"},"uboCount":{"type":"integer","description":"Count of the number of UBO's associated to the profile"},"openAlertCount":{"type":"integer","description":"Count of the number of open alerts associated to the profile"},"modeOfCreation":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"How the record was created [manual, batch]"},"children":[]}]}]}]},"importStatus":{"type":["string","null"],"description":"The current status of the import"},"isLocked":{"type":"boolean"},"isKycMonitored":{"type":"boolean"},"correlationId":{"type":"string","description":"A unique ID assigned to this request."}},"example":{"id":"fd91185f-c10e-4a42-b0b4-cc367371ebdb","name":"tej","riskRating":"notApplicable","status":"new","type":"trust","internalId":null,"assignedToId":101562008,"assignedTo":"Amol","safeNumber":null,"formationDate":null,"createdAt":"2023-07-25T09:32:40.428637Z","createdById":101562008,"createdBy":"Amol","modifiedAt":"2023-07-25T14:50:50.170613Z","modifiedById":101562008,"modifiedBy":"Amol","kycApprovedAt":null,"kycReviewOn":null,"kycStatusUpdatedOn":"2023-07-25T09:32:40.428637Z","kycComments":null,"noteCount":0,"attachmentCount":0,"keyPartyCount":0,"uboCount":0,"openAlertCount":0,"modeOfCreation":"import","importStatus":null,"isLocked":false,"isKycMonitored":false,"correlationId":"81e542c0-f644-4ef8-ba35-5f16c8681420"}}},"components/schemas/UpdateKYCProfileByProfileIdRequest":{"id":"components/schemas/UpdateKYCProfileByProfileIdRequest","kind":"json-schema","title":"UpdateKYCProfileByProfileIdRequest","data":{"type":"object","required":["name","riskRating","status"],"properties":{"name":{"type":["string","null"],"description":"The name of the profile to be updated."},"riskRating":{"type":["string","null"],"enum":["notApplicable","veryLow","low","medium","high","veryHigh"],"description":"Risk rating of the profile.","example":"notApplicable"},"status":{"description":"Status of the profile.","type":["string","null"],"enum":["new","approved","declined","pending","cancelled","referred","closed","approvedReviewDue"],"example":"new"},"internalId":{"type":["string","null"],"description":"Internal ID of the profile, this MUST be unique across your profiles."},"assignedToId":{"type":["integer","null"],"format":"int32","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creditsafe Id of the user to assign the profile to. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Passing null will unassign the profile."},"children":[]}]}]}]},"kycReviewOn":{"type":["string","null"],"format":"date","example":"2021-04-20","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date to which the profile should be reviewed. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Format YYYY-MM-DD "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Validates when the date changes and is either current or in the future."},"children":[]}]}]}]},"kycComments":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Free text field for users to highlight key information to other users. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Maximum characters allowed is 250"},"children":[]}]}]}]}}}},"components/schemas/UpdateKYCProfileByProfileId":{"id":"components/schemas/UpdateKYCProfileByProfileId","kind":"json-schema","title":"UpdateKYCProfileByProfileId","data":{"type":"object","properties":{"id":{"type":"string","description":"Id of the Profile","format":"uuid"},"name":{"type":"string","description":"Name of the Profile"},"riskRating":{"type":"string","description":"The risk rating being assigned to the profile","enum":["notApplicable","veryLow","low","medium","high","veryHigh"]},"status":{"type":"string","description":"Status of the profile (new, approved, declined, pending, cancelled, referred, closed, approvedReviewDue)"},"type":{"type":"string","description":"Type of the profile (trust, individual, soleTrader, company, plc, partnership, otherEntity)"},"internalId":{"type":"string","description":"Internal Id of the profile."},"assignedToId":{"type":"integer","description":"Id of the user assigned to the profile"},"assignedTo":{"type":"string","description":"Name of the user assigned to the profile"},"safeNumber":{"type":"string","description":"safe number of the business linked to the profile"},"companyId":{"type":"string","description":"company id of the business linked to the profile"},"formationDate":{"type":"string","description":"Formation date of the business linked to the profile","format":"date"},"createdAt":{"type":"string","description":"Profile created time","format":"date-time"},"createdById":{"type":"integer","description":"Id of the user who created the profile","format":"int32"},"createdBy":{"type":"string","description":"Name of the user who created the profile"},"modifiedAt":{"type":"string","description":"Profile last updated time","format":"date-time"},"modifiedById":{"type":"integer","description":"Id of the user who last modified the profile","format":"int32"},"modifiedBy":{"type":"string","description":"Name of the user who last modified the profile"},"kycApprovedAt":{"type":"string","description":"Date when the profile got approved","format":"date-time"},"kycReviewOn":{"type":"string","description":"Date when profile is to be reviewed","format":"date"},"kycStatusUpdatedOn":{"type":"string","description":"Date when the profile status was last updated","format":"date-time"},"kycComments":{"type":"string","description":"Profile comments"},"noteCount":{"type":"integer","description":"Count of notes associated with profile","format":"int32"},"attachmentCount":{"type":"integer","description":"Count of attachments associated with profile","format":"int32"},"keyPartyCount":{"type":"integer","description":"Count of key parties associated with profile","format":"int32"},"uboCount":{"type":"integer","description":"Count of UBOs associated with profile","format":"int32"},"openAlertCount":{"type":"integer","description":"Count of Open Alerts","format":"int32"},"modeOfCreation":{"type":"string","description":"Mode of profile creation (manual, import)"},"importStatus":{"type":"string","description":"Status of profile creation (submitted, preprocessed, validated, queued, inProgress, processed, completed, partiallyCompleted, failed)"},"isLocked":{"type":"boolean","description":"Value indicating whether the profile is locked"}}}},"components/schemas/KYCProtectBaseIndividualSearchResultHitSummaryResponse":{"id":"components/schemas/KYCProtectBaseIndividualSearchResultHitSummaryResponse","kind":"json-schema","title":"KYCProtectBaseIndividualSearchResultHitSummaryResponse","data":{"type":"object","properties":{"id":{"type":"string","description":"The Id of the search hit.","format":"uuid"},"hitScore":{"type":"integer","description":"The hit score associated to the search hit.","format":"int32"},"name":{"type":["string","null"],"description":"The name associated to the search hit."},"match":{"type":["string","null"],"description":"The match string associated to the search hit."},"countries":{"type":["array","null"],"items":{"type":"string"},"description":"The countries associated to the search hit."},"datasets":{"type":["array","null"],"items":{"type":"string"},"description":"The datasets associated to the search hit."},"decision":{"enum":["undecided","trueMatch","falsePositive","discarded"],"type":"string","description":"The decision made on the search hit."},"note":{"type":["string","null"],"description":"The note added to the search hit."},"modifiedById":{"type":"integer","description":"The search hit last modified by user id.","format":"int32"},"modifiedBy":{"type":["string","null"],"description":"The search hit last modified by user name."},"modifiedAt":{"type":"string","description":"The search hit last modified date and time.","format":"date-time"},"createdAt":{"type":"string","description":"The search hit created date and time.","format":"date-time"},"firstName":{"type":["string","null"],"description":"The first name of the search hit."},"middleName":{"type":["string","null"],"description":"The middle name of the search hit."},"lastName":{"type":["string","null"],"description":"The last name of the search hit."},"gender":{"enum":["male","female"],"type":["string","null"],"description":"The gender associated to the search hit."},"datesOfBirth":{"type":["string","null"],"items":{"type":"string","description":"Can be in the format YYYY or YYYY-MM-DD","format":"date"},"description":"The dates of birth associated to the search hit."},"pepTier":{"enum":["pepTier1","pepTier2","pepTier3"],"type":["string","null"],"description":"The pep tier associated to the search hit."},"profileImages":{"type":["array","null"],"items":{"type":"string"},"description":"The profile images associated to the search hit."}},"additionalProperties":false}},"components/schemas/KYCProtectScheduleHitResponse":{"id":"components/schemas/KYCProtectScheduleHitResponse","kind":"json-schema","title":"KYCProtectScheduleHitResponse","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The id of the schedule"},"searchId":{"type":"string","description":"The id of the search that was being scheduled","format":"uuid"},"profileId":{"type":["string","null"],"description":"The id of the profile linked to the search that was being scheduled","format":"uuid"},"scheduleId":{"type":"string","description":"The id of the schedule","format":"uuid"},"keyPartyId":{"type":["string","null"],"description":"The id of the key party linked to the search that was being scheduled","format":"uuid"},"searchType":{"enum":["individual","business"],"type":"string","description":"The type of the search that was being scheduled"},"supersededHit":{"$ref":"#/components/schemas/KYCProtectBaseIndividualSearchResultHitSummaryResponse"},"firstName":{"type":["string","null"],"description":"The first name of the search hit."},"middleName":{"type":["string","null"],"description":"The middle name of the search hit."},"lastName":{"type":["string","null"],"description":"The last name of the search hit."},"gender":{"enum":["male","female"],"type":["string","null"],"description":"The gender associated to the search hit."},"datesOfBirth":{"type":["array","null"],"items":{"type":"string","description":"Can be in the format YYYY or YYYY-MM-DD","format":"date"},"description":"The dates of birth associated to the search hit."},"pepTier":{"enum":["pepTier1","pepTier2","pepTier3"],"type":["string","null"],"description":"The pep tier associated to the search hit."},"profileImages":{"type":["array","null"],"items":{"type":"string"},"description":"The profile images associated to the search hit."},"hitScore":{"type":"integer","description":"The hit score associated to the search hit.","format":"int32"},"name":{"type":["string","null"],"description":"The name associated to the search hit."},"match":{"type":["string","null"],"description":"The match string associated to the search hit."},"countries":{"type":["array","null"],"items":{"type":"string"},"description":"The countries associated to the search hit."},"datasets":{"type":["array","null"],"items":{"type":"string"},"description":"The datasets associated to the search hit."},"decision":{"enum":["undecided","trueMatch","falsePositive","discarded"],"type":"string","description":"The decision made on the search hit."},"note":{"type":["string","null"],"description":"The note added to the search hit."},"modifiedById":{"type":"integer","description":"The search hit last modified by user id.","format":"int32"},"modifiedBy":{"type":["string","null"],"description":"The search hit last modified by user name."},"modifiedAt":{"type":"string","description":"The search hit last modified date and time.","format":"date-time"},"createdAt":{"type":"string","description":"The search hit created date and time.","format":"date-time"}},"additionalProperties":false}},"components/schemas/KycProtectProfileGetAttachmentResponse":{"id":"components/schemas/KycProtectProfileGetAttachmentResponse","kind":"json-schema","title":"KycProtectProfileGetAttachmentResponse","data":{"type":"object","properties":{"id":{"type":"string","description":"Attachment Id.","format":"uuid"},"fileName":{"type":"string","description":"Example:passport.pdf (Attachment Name)."},"fileSizeInBytes":{"type":"integer","description":"Size of the attachment in bytes.","format":"int64"},"documentType":{"type":"string","description":"Document type of the attachment."},"description":{"type":["string","null"],"description":"Description of the attachment."},"createdAt":{"type":"string","description":"Attachment uploaded time.","format":"date-time"},"createdById":{"type":"integer","description":"Attachment uploaded by user id","format":"int32"},"createdBy":{"type":"string","description":"Attachment uploaded by user"},"modifiedAt":{"type":["string","null"],"description":"Attachment modified time","format":"date-time"},"modifiedById":{"type":["integer","null"],"description":"Attachment modified by user id","format":"int32"},"modifiedBy":{"type":["string","null"],"description":"Attachment modified by user"},"linkedTo":{"type":["string","null"],"description":"The profile component to which current attachment is linked to. Available values are profile and profileDetails."}}}},"components/schemas/KycProtectProfileAttachmentResponse":{"id":"components/schemas/KycProtectProfileAttachmentResponse","kind":"json-schema","title":"KycProtectProfileAttachmentResponse","data":{"type":"object","properties":{"id":{"type":"string","description":"Attachment Id.","format":"uuid"},"fileName":{"type":"string","description":"Example:passport.pdf (Attachment Name)."},"fileSizeInBytes":{"type":"integer","description":"Size of the attachment in bytes.","format":"int64"},"documentType":{"type":"string","description":"Document type of the attachment."},"description":{"type":"string","description":"Description of the attachment."},"createdAt":{"type":"string","description":"Attachment uploaded time.","format":"date-time"},"createdById":{"type":"integer","description":"Attachment uploaded by user id","format":"int32"},"createdBy":{"type":"string","description":"Attachment uploaded by user"},"modifiedAt":{"type":"string","description":"Attachment modified time","format":"date-time"},"modifiedById":{"type":"integer","description":"Attachment modified by user id","format":"int32"},"modifiedBy":{"type":"string","description":"Attachment modified by user"}}}},"components/schemas/GetKYCProfileAttachmentDetailsByAttachmentId":{"id":"components/schemas/GetKYCProfileAttachmentDetailsByAttachmentId","kind":"json-schema","title":"GetKYCProfileAttachmentDetailsByAttachmentId","data":{"type":"object","properties":{"id":{"type":"string","description":"Attachment Id.","format":"uuid"},"fileName":{"type":"string","description":"Example : passport.pdf\r\nAttachment Name."},"fileSizeInBytes":{"type":"integer","description":"Size of the attachment in bytes.","format":"int64"},"documentType":{"type":"string","description":"Document type of the attachment."},"description":{"type":["string","null"],"description":"Description of the attachment."},"createdAt":{"type":"string","description":"Attachment uploaded time.","format":"date-time"},"createdById":{"type":"integer","description":"Attachment uploaded by user id","format":"int32"},"createdBy":{"type":"string","description":"Attachment uploaded by user"},"modifiedAt":{"type":["string","null"],"description":"Attachment modified time","format":"date-time"},"modifiedById":{"type":["integer","null"],"description":"Attachment modified by user id","format":"int32"},"modifiedBy":{"type":["string","null"],"description":"Attachment modified by user"},"linkedTo":{"type":["string","null"],"description":"The profile component to which current attachment is linked to."}}}},"components/schemas/UpdateKYCAttachmentsByAttachmentIdRequest":{"id":"components/schemas/UpdateKYCAttachmentsByAttachmentIdRequest","kind":"json-schema","title":"UpdateKYCAttachmentsByAttachmentIdRequest","data":{"type":"object","properties":{"documentType":{"type":"string","description":"The document type of the attachment"},"description":{"type":"string","description":"The description of the attachment. Limited to 250 characters."}}}},"components/schemas/UpdateKYCAttachmentsByAttachmentId":{"id":"components/schemas/UpdateKYCAttachmentsByAttachmentId","kind":"json-schema","title":"UpdateKYCAttachmentsByAttachmentId","data":{"type":"object","properties":{"id":{"type":"string","description":"Attachment Id.","format":"uuid"},"fileName":{"type":"string","description":"Example : passport.pdf\r\nAttachment Name."},"fileSizeInBytes":{"type":"integer","description":"Size of the attachment in bytes.","format":"int64"},"documentType":{"type":"string","description":"Document type of the attachment."},"description":{"type":"string","description":"Description of the attachment."},"createdAt":{"type":"string","description":"Attachment uploaded time.","format":"date-time"},"createdById":{"type":"integer","description":"Attachment uploaded by user id","format":"int32"},"createdBy":{"type":"string","description":"Attachment uploaded by user"},"modifiedAt":{"type":"string","description":"Attachment modified time","format":"date-time"},"modifiedById":{"type":"integer","description":"Attachment modified by user id","format":"int32"},"modifiedBy":{"type":"string","description":"Attachment modified by user"}}}},"components/schemas/DownloadAttachmentResponse":{"id":"components/schemas/DownloadAttachmentResponse","kind":"json-schema","title":"DownloadAttachmentResponse","data":{"type":"object","properties":{"downloadUrl":{"type":"string","description":"Url of the file to download"},"fileName":{"type":"string","description":"Name of the file"},"expiresAt":{"type":"string","description":"Date and time when the url will expire","format":"date-time"},"correlationId":{"type":"string"}},"example":{"downloadUrl":"https://kyc-protect-api-test.s3.eu-west-1.amazonaws.com/customers/103077765/profiles/2770ac31-8d12-4f69-8f93-326e93cd8c34/attachments/103077765.101562008.passport.a9747b86-20f6-4abe-b846-66c5fac81d1f?X-Amz-Expires=3600&X-Amz-Security-Token=IQoJb3JpZ2luX2VjEPL%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaCWV1LXdlc3QtMSJHMEUCIQC0YiHwxSeo7ae6bLIhgQD0QKPkZeAnQMM%2BZWVRAhiFYgIgeQZ4yyr8DYxSX%2FNwHw5uxyqmNl3v3%2BZSL5MjHPlpfNYqlAQIm%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FARAEGgw3MTIzOTA1ODYzNzEiDA4bvxjS1wkV2ibkFSroAzem6chzKCy1MWXBX8yOrpNUXC%2BSpEamSfxyzv0bqdbFNkt%2BBJsYdBeFLy2aiDLqLQbURhbIwBEFgVfbXyyBQJPH%2BSnL46Sg%2FK7HwdgFm90P4tuXm4VQse5Oq5%2FcP7XN4z39TXAVUlqK3LRhKI6qJxAP9TdbBI1FSb1A0DW3AXboLPWd4th2hGeivyjnwkBt221%2B7dNZ0ts8%2FHALLyCpDBZ7gADsMSUSoQDK0b04v2ORz7bkx3O4huRel3IKi9SBCYzARlwJbNTnko25hPD0%2B%2FZB%2F2c%2BArEv6XOzzyny5%2BjVIxpa19pikdDiyppMQ5f6%2BJw2qk%2FQtcIuZlqugvB35s4A3I6GQr0kWX%2B%2Bh134krwwJUTZ1SiL0jQNEtHSd7%2BZ7wvUi0%2FKHXFdGmnkdQEUDTUbWNrndiyIDBFqQ0uSdFX1MHMWw%2FoQnoutX0qe%2Farvhm3VbOfE%2FKa0y0p2APeHylERt%2FslZXBTNPrEsuypO0hDQ1vbZMmnDekekk0hS0SzH8JGo3Fkgs5TkESppcZHm6QIFCkI9uTGsz0J2YH08MbHFCjDePCzhXH6wW1uggnw%2BM42lrOEK4UrVE5dv4HegVV%2B50QbrtYdReQX0qkJEozBCLEAxWrtNFjoGELqWznRI4soacjUcG%2FBMKLky6YGOqUB77yUlvzEKMUsOZOIkqx9GNo2Y1ch%2FXAWxxpx0D67LaQy6QC4kkoqakLtN2%2F80HnIkPBcbHS2C5KcGdq5%2FuMWl7qHUgltt5cFXRaOs8fYx%2BgKJ0p2vWZ53CqFh2MfYVV%2F1aw%2BDyeyF9rr4VEgR4hP2Ap3gZJOCKvIeF4oelgyo%2FGkmM%2FOLH%2FoBtfqC%2F8XWfCYR16i1eWyV7DTbwQ%2FicZp5%2Bx5%2BJjV&response-content-disposition=attachment%3B%20filename%3DNL-X-170661060000.pdf&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIA2LXOJWABRHEIT4WD/20230809/eu-west-1/s3/aws4_request&X-Amz-Date=20230809T070634Z&X-Amz-SignedHeaders=host&X-Amz-Signature=0fada68386fbe02d811a8fa4dd3825b06319be0ebf1cc9c11d427aa8e9530f95","fileName":"NL-X-170661060000.pdf","expiresAt":"2023-08-09T08:06:34.3212061Z","correlationId":"ee4228cc-68ed-413a-a547-79c5703017eb"}}},"components/schemas/GetKYCProfileDetailsByProfileId":{"id":"components/schemas/GetKYCProfileDetailsByProfileId","kind":"json-schema","title":"GetKYCProfileDetailsByProfileId","data":{"type":"object","properties":{"profileId":{"type":"string","description":"Id of the profile","format":"uuid"},"legalName":{"type":["string","null"],"description":"Name of the business/individual"},"tradingName":{"type":["string","null"],"description":"Trading name of the entity"},"aliases":{"type":["array","null"],"items":{"type":"string"},"description":"Alias names given for the entity"},"activity":{"type":["string","null"],"description":"Activity of the business e.g., NAICS/SIC codes"},"description":{"type":["string","null"],"description":"Description of the entity"},"contactName":{"type":["string","null"],"description":"Contact person name"},"email":{"type":["string","null"],"description":"Contact email address"},"website":{"type":["string","null"],"description":"Entity website address"},"telephone":{"type":["string","null"],"description":"Contact telephone number"},"turnover":{"type":"object","properties":{"currencyCode":{"type":["string","null"],"description":"The Currency code the amount is in"},"amount":{"type":["number","null"],"description":"The currency code associated with this amount should be provided","format":"double"}}},"assetsUnderManagement":{"type":"object","properties":{"currencyCode":{"type":["string","null"],"description":"The Currency code the amount is in"},"amount":{"type":["number","null"],"description":"The currency code associated with this amount should be provided","format":"double"}}},"dateOfBirth":{"type":["string","null"],"description":"Date of birth of the individual","format":"date"},"countryCode":{"type":["string","null"],"description":"Two-letter country code ISO-3166-2"},"vatNo":{"type":["string","null"],"description":"Tax Identification Number of the business"},"isListedOnExchange":{"type":["boolean","null"],"description":"Details of company listed on exchange"},"exchangeName":{"type":["string","null"],"description":"Gets the name of the exchange."},"organizationNumber":{"type":["string","null"],"description":"Gets the organisation number."},"internalContact":{"type":["string","null"],"description":"Gets the internal contact."},"internalEmail":{"type":["string","null"],"description":"Gets the internal email."},"internationalScore":{"type":["string","null"],"description":"Gets the international score."},"createdAt":{"type":"string","description":"Profile details created time","format":"date-time"},"createdById":{"type":"integer","description":"Id of the user who created profile","format":"int32"},"createdBy":{"type":"string","description":"Name of the user who created profile"},"modifiedAt":{"type":["string","null"],"description":"Profile details last updated time","format":"date-time"},"modifiedById":{"type":["integer","null"],"description":"Id of the user who last modified the profile","format":"int32"},"modifiedBy":{"type":["string","null"],"description":"Name of the user who last modified the profile"},"noteCount":{"type":"integer","description":"Count of notes associated with profile details","format":"int32"},"attachmentCount":{"type":"integer","description":"Count of attachment associated with profile details","format":"int32"},"correlationId":{"type":"string"}},"example":{"profileId":"2770ac31-8d12-4f69-8f93-326e93cd8c34","legalName":"string","tradingName":"string","aliases":["string"],"activity":"string","description":"string","contactName":"string","email":"string","website":"string","telephone":"string","turnover":{"currencyCode":"eur","amount":0},"assetsUnderManagement":{"currencyCode":"eur","amount":0},"dateOfBirth":"2024-02-27","countryCode":"string","vatNo":"string","isListedOnExchange":true,"exchangeName":"string","organizationNumber":"string","internalContact":"string","internalEmail":"string","createdAt":"2023-08-07T07:12:43.331308Z","createdById":101562008,"createdBy":"Amol","modifiedAt":"2023-08-08T07:16:27.734212Z","modifiedById":101562008,"modifiedBy":"Amol","noteCount":0,"attachmentCount":2,"correlationId":"70fd7603-1f75-4de6-8e38-a3c79ac24947"}}},"components/schemas/PutKYCProfileDetailsByProfileIdRequest":{"id":"components/schemas/PutKYCProfileDetailsByProfileIdRequest","kind":"json-schema","title":"PutKYCProfileDetailsByProfileIdRequest","data":{"type":"object","required":["legalName"],"properties":{"legalName":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name of the Business or Individual"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Maximum length is 150 characters"},"children":[]}]}]}],"example":"Creditsafe Ltd"},"tradingName":{"type":["string","null"],"example":null,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid for profile type - SoleTrader"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Maximum length is 150 characters"},"children":[]}]}]}]},"aliases":{"type":["array","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name of any Aliases"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Maximum length of each alias is 150 characters"},"children":[]}]}]}],"items":{"type":"string"},"example":null},"activity":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Activity of the Business e.g. NAIC S/SIC Codes"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Valid for profile types - Trust, Company, Partnership, OtherEntity and PLC"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Maximum length of activity is 150 characters"},"children":[]}]}]}],"example":"62409"},"description":{"type":["string","null"],"example":"Example Free Text","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description of the business/individual entity"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Valid for the profile types Trust, Company, Partnership, OtherEntity and PLC"},"children":[]}]}]}]},"contactName":{"type":["string","null"],"description":"Contact person at the organisation.","example":null},"email":{"type":["string","null"],"description":"Contact email address of the entity","example":"example@creditsafe.com"},"website":{"type":["string","null"],"example":"www.creditsafe.com","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Website address of the entity"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Valid for the profile types Trust, Company, Partnership, OtherEntity and PLC"},"children":[]}]}]}]},"telephone":{"type":["string","null"],"example":null,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Telephone number of the entity."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Valid for the profile types Trust, Company, Partnership, OtherEntity and PLC"},"children":[]}]}]}]},"turnover":{"type":"object","properties":{"currencyCode":{"type":["string","null"],"description":"The currency code the amount is in","enum":["eur","gbp","usd","cny","cad","aud","nzd","inr","jpy","chf","zar","dkk","sek","nok"]},"amount":{"description":"Total Turnover Figure","type":["integer","null"]}}},"assetsUnderManagement":{"type":"object","properties":{"currencyCode":{"type":["string","null"],"description":"The currency code the amount is in","enum":["eur","gbp","usd","cny","cad","aud","nzd","inr","jpy","chf","zar","dkk","sek","nok"]},"amount":{"type":["integer","null"],"description":"The total value of the assets under management"}}},"organizationNumber":{"type":["string","null"],"description":"Property valid for profile type - Trust, Company, Partnership, OtherEntity and PLC","example":"12345678"},"internalContact":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal contact name to contact regarding this profile,"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Property valid for profile type - Trust, Company, Partnership, OtherEntity and PLC."},"children":[]}]}]}],"example":null},"internalEmail":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal email address to contact regarding this profile."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Property valid for profile type - Trust, Company, Partnership, OtherEntity and PLC"},"children":[]}]}]}],"example":null},"dateOfBirth":{"type":["string","null"],"format":"date","example":"2024-03-25","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date YYYY-MM-DD or YYYY format. Must be after 1900 and not in the future"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Valid for the profile types Individual and SoleTrader"},"children":[]}]}]}]},"countryCode":{"type":["string","null"],"example":"GB","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Two-letter country code ISO-3166-2."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Valid for the profile types Individual and SoleTrader"},"children":[]}]}]}]},"vatNo":{"type":["string","null"],"example":"GB12345678","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tax Identification Number of the business"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Valid for the profile types Company, Partnership, OtherEntity and PLC"},"children":[]}]}]}]},"isListedOnExchange":{"type":["boolean","null"],"description":"Property valid for profile type PLC","example":null},"exchangeName":{"type":["string","null"],"description":"Property valid for profile type PLC","example":null}}}},"components/schemas/PutKYCProfileDetailsByProfileId":{"id":"components/schemas/PutKYCProfileDetailsByProfileId","kind":"json-schema","title":"PutKYCProfileDetailsByProfileId","data":{"type":"object","properties":{"profileId":{"type":"string","description":"Id of the profile","format":"uuid"},"legalName":{"type":"string","description":"Name of the business/individual"},"tradingName":{"type":"string","description":"Trading name of the entity"},"aliases":{"type":"array","description":"Alias names given for the entity","items":{"type":"string"}},"activity":{"type":"string","description":"Activity of the business e.g., NAICS/SIC codes"},"description":{"type":"string","description":"Description of the entity"},"contactName":{"type":"string","description":"Contact person name"},"email":{"type":"string","description":"Contact email address"},"website":{"type":"string","description":"Entity website address"},"telephone":{"type":"string","description":"Contact telephone number"},"turnover":{"type":"object","properties":{"currencyCode":{"type":"string","description":"The Currency code the amount is in"},"amount":{"type":"number","description":"The currency code associated with this amount should be provided","format":"double"}}},"assetsUnderManagement":{"type":"object","properties":{"currencyCode":{"type":"string","description":"The Currency code the amount is in"},"amount":{"type":"number","description":"The currency code associated with this amount should be provided","format":"double"}}},"dateOfBirth":{"type":"string","description":"Date of birth of the individual","format":"date"},"countryCode":{"type":"string","description":"Two-letter country code ISO-3166-2"},"vatNo":{"type":"string","description":"Tax Identification Number of the business"},"isListedOnExchange":{"type":"boolean","description":"Details of company listed on exchange"},"exchangeName":{"type":"string","description":"Gets the name of the exchange."},"organizationNumber":{"type":"string","description":"Gets the organisation number."},"internalContact":{"type":"string","description":"Gets the internal contact."},"internalEmail":{"type":"string","description":"Gets the internal email."},"internationalScore":{"type":"string","description":"Gets the international score."},"createdAt":{"type":"string","description":"Profile details created time","format":"date-time"},"createdById":{"type":"integer","description":"Id of the user who created profile","format":"int32"},"createdBy":{"type":"string","description":"Name of the user who created profile"},"modifiedAt":{"type":"string","description":"Profile details last updated time","format":"date-time"},"modifiedById":{"type":"integer","description":"Id of the user who last modified the profile","format":"int32"},"modifiedBy":{"type":"string","description":"Name of the user who last modified the profile"},"noteCount":{"type":"integer","description":"Count of notes associated with profile details","format":"int32"},"attachmentCount":{"type":"integer","description":"Count of attachment associated with profile details","format":"int32"}}}},"components/schemas/KycProtectProfileGetDetailsAddressResponse":{"id":"components/schemas/KycProtectProfileGetDetailsAddressResponse","kind":"json-schema","title":"KycProtectProfileGetDetailsAddressResponse","data":{"type":"object","properties":{"id":{"type":"string","description":"Id of the address","format":"uuid"},"buildingDetails":{"type":"string","description":"Building details of the address"},"street":{"type":"string","description":"Street of the address"},"city":{"type":"string","description":"City of the address"},"region":{"type":"string","description":"Region of the address"},"postalCode":{"type":"string","description":"Postalcode of the address"},"countryCode":{"type":"string","description":"Two-letter country code ISO-3166-2"},"type":{"type":"string","description":"Type of the address (registered, trading, other)"},"description":{"type":"string","description":"Description of the address"},"createdAt":{"type":"string","description":"Address created date time","format":"date-time"},"createdById":{"type":"integer","description":"Id of the user who created the Address","format":"int32"},"createdBy":{"type":"string","description":"Name of the user who created the Address"},"modifiedAt":{"type":"string","description":"Address last updated date time","format":"date-time"},"modifiedById":{"type":"integer","description":"Id of the user who last modified the Address","format":"int32"},"modifiedBy":{"type":"string","description":"Name of the user who last modified the Address"}}}},"components/schemas/KycProtectProfileAddressResponse":{"id":"components/schemas/KycProtectProfileAddressResponse","kind":"json-schema","title":"KycProtectProfileAddressResponse","data":{"type":"object","properties":{"id":{"type":"string","description":"Id of the address","format":"uuid"},"buildingDetails":{"type":["string","null"],"description":"Building details of the address"},"street":{"type":["string","null"],"description":"Street of the address"},"city":{"type":["string","null"],"description":"City of the address"},"region":{"type":["string","null"],"description":"Region of the address"},"postalCode":{"type":["string","null"],"description":"Postalcode of the address"},"countryCode":{"type":["string","null"],"description":"Two-letter country code ISO-3166-2"},"type":{"type":"string","description":"Type of the address (registered, trading, other)"},"description":{"type":["string","null"],"description":"Description of the address"},"createdAt":{"type":"string","description":"Address created date time","format":"date-time"},"createdById":{"type":"integer","description":"Id of the user who created the Address","format":"int32"},"createdBy":{"type":"string","description":"Name of the user who created the Address"},"modifiedAt":{"type":["string","null"],"description":"Address last updated date time","format":"date-time"},"modifiedById":{"type":["integer","null"],"description":"Id of the user who last modified the Address","format":"int32"},"modifiedBy":{"type":["string","null"],"description":"Name of the user who last modified the Address"}}}},"components/schemas/GetKYCAddressDetailsByTheGivenAddressIdForTheSuppliedProfileIdUser":{"id":"components/schemas/GetKYCAddressDetailsByTheGivenAddressIdForTheSuppliedProfileIdUser","kind":"json-schema","title":"GetKYCAddressDetailsByTheGivenAddressIdForTheSuppliedProfileIdUser","data":{"type":"object","properties":{"id":{"type":"string","description":"The id of the address.","format":"uuid"},"buildingDetails":{"type":["string","null"],"description":"The building details of the address being created. Must have a maximum length of 250 characters."},"street":{"type":["string","null"],"description":"The street of the address being created. Must have a maximum length of 250 characters."},"city":{"type":["string","null"],"description":"The city of the address being created. Must have a maximum length of 250 characters."},"region":{"type":["string","null"],"description":"The region of the address being created. Must have a maximum length of 250 characters."},"postalCode":{"type":["string","null"],"description":"The postal code of the address being created. Must have a maximum length of 50 characters."},"countryCode":{"type":["string","null"],"description":"The country code of the address being created."},"type":{"type":"string","description":"The type of the address.","enum":["registered","trading","other"]},"description":{"type":["string","null"],"description":"The description of the address being created. Must have a maximum length of 250 characters."},"createdAt":{"type":"string","description":"Address created date time","format":"date-time"},"createdById":{"type":"integer","description":"Id of the user who created the Address","format":"int32"},"createdBy":{"type":"string","description":"Name of the user who created the Address"},"modifiedAt":{"type":["string","null"],"description":"Address last updated date time","format":"date-time"},"modifiedById":{"type":["integer","null"],"description":"Id of the user who last modified the Address","format":"int32"},"modifiedBy":{"type":["string","null"],"description":"Name of the user who last modified the Address"}}}},"components/schemas/UpdateKYCAddressDetailsByTheGivenAddressIdForTheSuppliedProfileIdUserRequest":{"id":"components/schemas/UpdateKYCAddressDetailsByTheGivenAddressIdForTheSuppliedProfileIdUserRequest","kind":"json-schema","title":"UpdateKYCAddressDetailsByTheGivenAddressIdForTheSuppliedProfileIdUserRequest","data":{"type":"object","properties":{"buildingDetails":{"type":["string","null"],"description":"The building details of the address being created. Must have a maximum length of 250 characters."},"street":{"type":["string","null"],"description":"The street of the address being created. Must have a maximum length of 250 characters."},"city":{"type":["string","null"],"description":"The city of the address being created. Must have a maximum length of 250 characters."},"region":{"type":["string","null"],"description":"The region of the address being created. Must have a maximum length of 250 characters."},"postalCode":{"type":["string","null"],"description":"The postal code of the address being created. Must have a maximum length of 50 characters."},"countryCode":{"type":["string","null"],"description":"The country code of the address being created."},"type":{"type":["string","null"],"description":"The type of the address.","enum":["registered","trading","other"]},"description":{"type":["string","null"],"description":"The description of the address being created. Must have a maximum length of 250 characters."}}}},"components/schemas/PutKYCAddressDetailsByTheGivenAddressIdForTheSuppliedProfileIdUser":{"id":"components/schemas/PutKYCAddressDetailsByTheGivenAddressIdForTheSuppliedProfileIdUser","kind":"json-schema","title":"PutKYCAddressDetailsByTheGivenAddressIdForTheSuppliedProfileIdUser","data":{"type":"object","properties":{"id":{"type":"string","description":"Id of the address","format":"uuid"},"buildingDetails":{"type":["string","null"],"description":"Building details of the address"},"street":{"type":["string","null"],"description":"Street of the address"},"city":{"type":["string","null"],"description":"City of the address"},"region":{"type":["string","null"],"description":"Region of the address"},"postalCode":{"type":["string","null"],"description":"Postalcode of the address"},"countryCode":{"type":["string","null"],"description":"Two-letter country code ISO-3166-2"},"type":{"type":"string","description":"Type of the address (registered, trading, other)"},"description":{"type":["string","null"],"description":"Description of the address"},"createdAt":{"type":"string","description":"Address created date time","format":"date-time"},"createdById":{"type":"integer","description":"Id of the user who created the Address","format":"int32"},"createdBy":{"type":"string","description":"Name of the user who created the Address"},"modifiedAt":{"type":["string","null"],"description":"Address last updated date time","format":"date-time"},"modifiedById":{"type":["integer","null"],"description":"Id of the user who last modified the Address","format":"int32"},"modifiedBy":{"type":["string","null"],"description":"Name of the user who last modified the Address"}}}},"components/schemas/GetProfileHitsByProfileIdResponse":{"id":"components/schemas/GetProfileHitsByProfileIdResponse","kind":"json-schema","title":"GetProfileHitsByProfileIdResponse","data":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The Id of the search hit."},"hitScore":{"type":"number","description":"The hit score associated to the search hit."},"name":{"description":"The name associated to the search hit.","type":["string","null"]},"match":{"description":"The match string associated to the search hit.","type":["string","null"]},"countries":{"description":"The countries associated to the search hit.","type":["array","null"],"items":{"type":"string"}},"datasets":{"description":"The datasets associated to the search hit.","type":["array","null"],"items":{"type":"string"}},"decision":{"type":"string","description":"The decision made on the search hit."},"note":{"description":"The note added to the search hit.","type":["string","null"]},"modifiedById":{"type":"number","description":"The search hit last modified by user id."},"modifiedBy":{"description":"The search hit last modified by user name.","type":["string","null"]},"modifiedAt":{"type":"string","description":"The search hit last modified date and time."},"createdAt":{"type":"string","description":"The search hit created date and time."},"firstName":{"description":"The first name of the search hit.","type":["string","null"]},"middleName":{"description":"The middle name of the search hit.","type":["string","null"]},"lastName":{"description":"The last name of the search hit.","type":["string","null"]},"gender":{"description":"The gender associated to the search hit.","type":["string","null"]},"datesOfBirth":{"description":"The dates of birth associated to the search hit.","type":["array","null"],"items":{"type":"string"}},"pepTier":{"description":"The pep tier associated to the search hit.","type":["string","null"]},"profileImages":{"description":"The profile images associated to the search hit.","type":["array","null"],"items":{"type":"string"}},"supersededHit":{"type":"object","properties":{"id":{"type":"string","description":"The Id of the search hit."},"hitScore":{"type":"number","description":"The hit score associated to the search hit."},"name":{"description":"The name associated to the search hit.","type":["string","null"]},"match":{"description":"The match string associated to the search hit.","type":["string","null"]},"countries":{"description":"The countries associated to the search hit.","type":["array","null"],"items":{"type":"string"}},"datasets":{"description":"The datasets associated to the search hit.","type":["array","null"],"items":{"type":"string"}},"decision":{"type":"string","description":"The decision made on the search hit."},"note":{"description":"The note added to the search hit.","type":["string","null"]},"modifiedById":{"type":"number","description":"The search hit last modified by user id."},"modifiedBy":{"description":"The search hit last modified by user name.","type":["string","null"]},"modifiedAt":{"type":"string","description":"The search hit last modified date and time."},"createdAt":{"type":"string","description":"The search hit created date and time."},"firstName":{"description":"The first name of the search hit.","type":["string","null"]},"middleName":{"description":"The middle name of the search hit.","type":["string","null"]},"lastName":{"description":"The last name of the search hit.","type":["string","null"]},"gender":{"description":"The gender associated to the search hit.","type":["string","null"]},"datesOfBirth":{"description":"The dates of birth associated to the search hit.","type":["array","null"],"items":{"type":"string"}},"pepTier":{"description":"The pep tier associated to the search hit.","type":["string","null"]},"profileImages":{"description":"The profile images associated to the search hit.","type":["array","null"],"items":{"type":"string"}}}},"searchId":{"type":"string","description":"The id of the search associated to the hit."},"searchType":{"type":"string","description":"The type of search associated to the hit."}}}},"totalSize":{"type":"number"}}}},"components/schemas/GetKeyPartiesResponseByProfileIdItemsAddressResponse":{"id":"components/schemas/GetKeyPartiesResponseByProfileIdItemsAddressResponse","kind":"json-schema","title":"GetKeyPartiesResponseByProfileIdItemsAddressResponse","data":{"type":"object","properties":{"id":{"type":"string","description":"Id of the address","format":"uuid"},"buildingDetails":{"type":["string","null"],"description":"Building details of the address"},"street":{"type":["string","null"],"description":"Street of the address"},"city":{"type":["string","null"],"description":"City of the address"},"region":{"type":["string","null"],"description":"Region of the address"},"postalCode":{"type":["string","null"],"description":"Postalcode of the address"},"countryCode":{"type":["string","null"],"description":"Two-letter country code ISO-3166-2"},"type":{"type":"string","description":"Type of the address. Available values are registered, trading and other."},"description":{"type":["string","null"],"description":"Description of the address"},"createdAt":{"type":"string","description":"Address created date time","format":"date-time"},"createdById":{"type":"integer","description":"Id of the user who created the Address","format":"int32"},"createdBy":{"type":"string","description":"Name of the user who created the Address"},"modifiedAt":{"type":["string","null"],"description":"Address last updated date time","format":"date-time"},"modifiedById":{"type":["integer","null"],"description":"Id of the user who last modified the Address","format":"int32"},"modifiedBy":{"type":["string","null"],"description":"Name of the user who last modified the Address"}}}},"components/schemas/GetKeyPartiesResponseByProfileIdItems":{"id":"components/schemas/GetKeyPartiesResponseByProfileIdItems","kind":"json-schema","title":"GetKeyPartiesResponseByProfileIdItems","data":{"type":"object","properties":{"id":{"type":"string","description":"Id of the key party","format":"uuid"},"name":{"type":"string","description":"Name of the key party"},"firstName":{"type":"string","description":"First name of the key party"},"middleName":{"type":["string","null"],"description":"Middle name of the key party"},"lastName":{"type":"string","description":"Last name of the key party"},"entityType":{"type":"string","description":"Entity type of the key party. Avaialable values are individual and business."},"keyPartyType":{"type":"string","description":"Type of the key party. Available values are director, shareHolder and ubo."},"gender":{"type":["string","null"],"description":"Gender of the key party. Available values are male and female."},"dateOfBirth":{"type":["string","null"],"description":"Date of birth of the key party","format":"date"},"organisationNumber":{"type":["string","null"],"description":"Key party organization number"},"activityCode":{"type":["string","null"],"description":"Activity code of the key party"},"percentageOfShares":{"type":["number","null"],"description":"Share percentage of the key party","format":"double"},"role":{"type":["string","null"],"description":"Role of the key party"},"countryCode":{"type":["string","null"],"description":"Country code of the key party"},"address":{"$ref":"#/components/schemas/GetKeyPartiesResponseByProfileIdItemsAddressResponse"},"searchId":{"type":["string","null"],"description":"Search Id of the key party","format":"uuid"},"createdAt":{"type":"string","description":"Key party created time","format":"date-time"},"createdById":{"type":"integer","description":"Id of the user who created the key party","format":"int32"},"createdBy":{"type":"string","description":"Name of the user who created the key party"},"modifiedAt":{"type":["string","null"],"description":"key party last updated time","format":"date-time"},"modifiedById":{"type":["integer","null"],"description":"Id of the user who last modified the key party","format":"int32"},"modifiedBy":{"type":["string","null"],"description":"Name of the user who last modified the key party"}}}},"components/schemas/GetKeyPartiesResponseByProfileId":{"id":"components/schemas/GetKeyPartiesResponseByProfileId","kind":"json-schema","title":"GetKeyPartiesResponseByProfileId","data":{"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/GetKeyPartiesResponseByProfileIdItems"}},"totalSize":{"type":"integer","format":"int64"}}}},"components/schemas/PutKYCKeypartiesByProfileIdRequest":{"id":"components/schemas/PutKYCKeypartiesByProfileIdRequest","kind":"json-schema","title":"PutKYCKeypartiesByProfileIdRequest","data":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","required":["keyPartyId"],"properties":{"name":{"type":["string","null"],"description":"Name of the key party Maximum length is 200 characters"},"firstName":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"First name of the key party "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Valid for only entity type Individual "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Maximum length is 200 characters combining First name, Middle name and Last name"},"children":[]}]}]}]},"middleName":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Middle name of the key party "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Valid for only entity type Individual "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Maximum length is 200 characters combining First name, Middle name and Last name"},"children":[]}]}]}]},"lastName":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Last name of the key party "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Valid for only entity type Individual "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Maximum length is 200 characters combining First name, Middle name and Last name"},"children":[]}]}]}]},"gender":{"type":["string","null"],"description":"Gender of the key party Valid for entity type Individual, male , female."},"dateOfBirth":{"type":["string","null"],"description":"Date of birth of the key party Date YYYY-MM-DD or YYYY format. Must be after 1900 and not in the future Valid for the entity type Individual"},"organisationNumber":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Key party organisation number "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Valid for entity type Business"},"children":[]}]}]}]},"activityCode":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Activity code of the key party "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Valid for entity type Business"},"children":[]}]}]}]},"percentageOfShares":{"type":["number","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Share percentage of the key party "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Valid for key party type ShareHolder"},"children":[]}]}]}]},"role":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Role of the key party "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Valid for key party type Director"},"children":[]}]}]}]},"countryCode":{"type":["string","null"],"description":"Country code of the key party"},"keyPartyId":{"type":["string","null"],"description":"The Id of the key party to be updated"},"address":{"type":"object","required":["type"],"properties":{"buildingDetails":{"type":["string","null"],"description":"The building details of the address being created. Must have a maximum length of 250 characters"},"street":{"type":["string","null"],"description":"The street of the address being created. Must have a maximum length of 250 characters"},"city":{"type":["string","null"],"description":"The city of the address being created. Must have a maximum length of 250 characters"},"region":{"type":["string","null"],"description":"The region of the address being created. Must have a maximum length of 250 characters"},"postalCode":{"type":["string","null"],"description":"The postal code of the address being created Must have a maximum length of 50 characters"},"countryCode":{"type":["string","null"],"description":"Two-letter ISO-3166-2 country code"},"type":{"type":["string","null"],"description":"Type of the address, registered, trading, other"},"description":{"type":["string","null"],"description":"The description of the address being created Must have a maximum length of 250 characters"}}}}}}}}},"components/schemas/PutKYCKeypartiesByProfileIdAddressContract":{"id":"components/schemas/PutKYCKeypartiesByProfileIdAddressContract","kind":"json-schema","title":"PutKYCKeypartiesByProfileIdAddressContract","data":{"required":["type"],"type":"object","properties":{"buildingDetails":{"type":["string","null"],"description":"The building details of the address being created.\r\nMust have a maximum length of 250 characters"},"street":{"type":["string","null"],"description":"The street of the address being created.\r\nMust have a maximum length of 250 characters"},"city":{"type":["string","null"],"description":"The city of the address being created.\r\nMust have a maximum length of 250 characters"},"region":{"type":["string","null"],"description":"The region of the address being created.\r\nMust have a maximum length of 250 characters"},"postalCode":{"type":["string","null"],"description":"The postal code of the address being created.\r\nMust have a maximum length of 50 characters"},"countryCode":{"type":["string","null"],"description":"The country code of the address being created."},"type":{"type":["string","null"],"description":"The country code of the address being created.registered, trading,other"},"description":{"type":["string","null"],"description":"The description of the address being created.\r\nMust have a maximum length of 250 characters"}}}},"components/schemas/PutKYCKeypartiesByProfileIdFailedContractResponse":{"id":"components/schemas/PutKYCKeypartiesByProfileIdFailedContractResponse","kind":"json-schema","title":"PutKYCKeypartiesByProfileIdFailedContractResponse","data":{"type":"object","properties":{"name":{"type":["string","null"],"description":"Name of the key party\r\nMaximum length is 200 characters"},"firstName":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"First name of the key party"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Valid for only entity type Individual "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Maximum length is 200 characters combining First name, Middle name and Last name"},"children":[]}]}]}]},"middleName":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Middle name of the key party"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Valid for only entity type Individual "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Maximum length is 200 characters combining First name, Middle name and Last name"},"children":[]}]}]}]},"lastName":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Last name of the key party"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Valid for only entity type Individual "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Maximum length is 200 characters combining First name, Middle name and Last name"},"children":[]}]}]}]},"gender":{"type":["string","null"],"description":"Gender of the key party\r\nValid for entity type Individual, male, female"},"dateOfBirth":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date of birth of the key party"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date YYYY-MM-DD or YYYY format. Must be after 1900 and not in the future"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Valid for the entity type Individual"},"children":[]}]}]}],"format":"date"},"organisationNumber":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Key party organisation number"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Valid for entity type Business"},"children":[]}]}]}]},"activityCode":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Activity code of the key party"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Valid for entity type Business"},"children":[]}]}]}]},"percentageOfShares":{"type":["number","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Share percentage of the key party"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Valid for key party type ShareHolder"},"children":[]}]}]}],"format":"double"},"role":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Role of the key party"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Valid for key party type Director"},"children":[]}]}]}]},"countryCode":{"type":["string","null"],"description":"Country code of the key party"},"address":{"$ref":"#/components/schemas/PutKYCKeypartiesByProfileIdAddressContract"},"keyPartyId":{"type":"string","description":"The Id of the key party to be updated","format":"uuid"}}}},"components/schemas/KycProtectErrorObject":{"id":"components/schemas/KycProtectErrorObject","kind":"json-schema","title":"KycProtectErrorObject","data":{"type":"object","properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"number"},"detail":{"type":"string"},"instance":{"type":"string"},"additionalProp1":{"type":"string"},"additionalProp2":{"type":"string"},"additionalProp3":{"type":"string"}}}},"components/schemas/PutKYCKeypartiesByProfileIdFailedResponse":{"id":"components/schemas/PutKYCKeypartiesByProfileIdFailedResponse","kind":"json-schema","title":"PutKYCKeypartiesByProfileIdFailedResponse","data":{"type":"object","properties":{"failedItem":{"$ref":"#/components/schemas/PutKYCKeypartiesByProfileIdFailedContractResponse"},"error":{"$ref":"#/components/schemas/KycProtectErrorObject"}}}},"components/schemas/PostKYCKeypartiesByProfileIdAddressContractResponse":{"id":"components/schemas/PostKYCKeypartiesByProfileIdAddressContractResponse","kind":"json-schema","title":"PostKYCKeypartiesByProfileIdAddressContractResponse","data":{"type":"object","properties":{"id":{"type":"string","description":"Id of the address","format":"uuid"},"buildingDetails":{"type":["string","null"],"description":"Building details of the address"},"street":{"type":["string","null"],"description":"Street of the address"},"city":{"type":["string","null"],"description":"City of the address"},"region":{"type":["string","null"],"description":"Region of the address"},"postalCode":{"type":["string","null"],"description":"Postalcode of the address"},"countryCode":{"type":["string","null"],"description":"Two-letter country code ISO-3166-2"},"type":{"type":"string","description":"Type of the address,registered,trading, other"},"description":{"type":["string","null"],"description":"Description of the address"},"createdAt":{"type":"string","description":"Address created date time","format":"date-time"},"createdById":{"type":"integer","description":"Id of the user who created the Address","format":"int32"},"createdBy":{"type":"string","description":"Name of the user who created the Address"},"modifiedAt":{"type":["string","null"],"description":"Address last updated date time","format":"date-time"},"modifiedById":{"type":["integer","null"],"description":"Id of the user who last modified the Address","format":"int32"},"modifiedBy":{"type":["string","null"],"description":"Name of the user who last modified the Address"}}}},"components/schemas/PostKYCKeypartiesByProfileIdResponse":{"id":"components/schemas/PostKYCKeypartiesByProfileIdResponse","kind":"json-schema","title":"PostKYCKeypartiesByProfileIdResponse","data":{"type":"object","properties":{"id":{"type":"string","description":"Id of the key party","format":"uuid"},"name":{"type":"string","description":"Name of the key party"},"firstName":{"type":"string","description":"First name of the key party"},"middleName":{"type":["string","null"],"description":"Middle name of the key party"},"lastName":{"type":"string","description":"Last name of the key party"},"entityType":{"type":"string","description":"Entity type of the key party, individual, business"},"keyPartyType":{"type":"string","description":"Type of the key party, director,shareHolder,ubo"},"gender":{"type":["string","null"],"description":"Gender of the key party, male, female"},"dateOfBirth":{"type":["string","null"],"description":"Date of birth of the key party","format":"date"},"organisationNumber":{"type":["string","null"],"description":"Key party organization number"},"activityCode":{"type":["string","null"],"description":"Activity code of the key party"},"percentageOfShares":{"type":["number","null"],"description":"Share percentage of the key party","format":"double"},"role":{"type":["string","null"],"description":"Role of the key party"},"countryCode":{"type":["string","null"],"description":"Country code of the key party"},"address":{"$ref":"#/components/schemas/PostKYCKeypartiesByProfileIdAddressContractResponse"},"searchId":{"type":["string","null"],"description":"Search Id of the key party","format":"uuid"},"createdAt":{"type":"string","description":"Key party created time","format":"date-time"},"createdById":{"type":"integer","description":"Id of the user who created the key party","format":"int32"},"createdBy":{"type":"string","description":"Name of the user who created the key party"},"modifiedAt":{"type":["string","null"],"description":"key party last updated time","format":"date-time"},"modifiedById":{"type":["string","null"],"description":"Id of the user who last modified the key party","format":"int32"},"modifiedBy":{"type":["string","null"],"description":"Name of the user who last modified the key party"}}}},"components/schemas/PostKYCKeypartiesByProfileIdRequest":{"id":"components/schemas/PostKYCKeypartiesByProfileIdRequest","kind":"json-schema","title":"PostKYCKeypartiesByProfileIdRequest","data":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"name":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name of the key party"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Maximum length is 200 characters"},"children":[]}]}]}]},"firstName":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"First name of the key party "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Valid for entity type Individual "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Maximum length is 200 characters combining First name, Middle name and Last name"},"children":[]}]}]}]},"middleName":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Middle name of the key party "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Valid for entity type Individual "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Maximum length is 200 characters combining First name, Middle name and Last name"},"children":[]}]}]}]},"lastName":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Last name of the key party "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Valid for entity type Individual "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Maximum length is 200 characters combining First name, Middle name and Last name"},"children":[]}]}]}]},"entityType":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Entity type of the key party "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Types - individual, business"},"children":[]}]}]}]},"keyPartyType":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Entity type of the key party"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Types - director, shareHolder, ubo"},"children":[]}]}]}]},"gender":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gender of the key party"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Valid for entity type Individual"},"children":[]}]}]}],"enum":["male","female"]},"dateOfBirth":{"type":["string","null"],"description":"Date of birth of the key party Date YYYY-MM-DD or YYYY format. Must be after 1900 and not in the future Valid for the entity type Individual"},"organisationNumber":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Key party organisation number "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Valid for entity type Business"},"children":[]}]}]}]},"activityCode":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Activity code of the key party "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Valid for entity type Business"},"children":[]}]}]}]},"percentageOfShares":{"type":["number","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Share percentage of the key party "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Valid for key party type ShareHolder"},"children":[]}]}]}]},"role":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Role of the key party "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Valid for key party type Director"},"children":[]}]}]}]},"countryCode":{"type":["string","null"],"description":"Country code of the key party"},"address":{"type":"object","required":["type"],"properties":{"buildingDetails":{"type":["string","null"],"description":"The building details of the address being created. Must have a maximum length of 250 characters"},"street":{"type":["string","null"],"description":"The street of the address being created. Must have a maximum length of 250 characters"},"city":{"type":["string","null"],"description":"The city of the address being created. Must have a maximum length of 250 characters"},"region":{"type":["string","null"],"description":"The region of the address being created. Must have a maximum length of 250 characters"},"postalCode":{"type":["string","null"],"description":"The postal code of the address being created Must have a maximum length of 50 characters"},"countryCode":{"type":["string","null"],"description":"Two-letter ISO-3166-2 country code"},"type":{"type":["string","null"],"description":"Type of the address, registered, trading, other"},"description":{"type":["string","null"],"description":"The description of the address being created Must have a maximum length of 250 characters"}}}}}}}}},"components/schemas/PostKYCKeypartiesByProfileIdAddressRequestContractResponse":{"id":"components/schemas/PostKYCKeypartiesByProfileIdAddressRequestContractResponse","kind":"json-schema","title":"PostKYCKeypartiesByProfileIdAddressRequestContractResponse","data":{"type":"object","properties":{"buildingDetails":{"type":["string","null"],"description":"The building details of the address being created.\r\nMust have a maximum length of 250 characters"},"street":{"type":["string","null"],"description":"The street of the address being created.\r\nMust have a maximum length of 250 characters"},"city":{"type":["string","null"],"description":"The city of the address being created.\r\nMust have a maximum length of 250 characters"},"region":{"type":["string","null"],"description":"The region of the address being created.\r\nMust have a maximum length of 250 characters"},"postalCode":{"type":["string","null"],"description":"The postal code of the address being created\r\nMust have a maximum length of 50 characters"},"countryCode":{"type":["string","null"],"description":"Two-letter ISO-3166-2 country code"},"type":{"type":["string","null"],"description":"Type of address, registered,trading, other"},"description":{"type":["string","null"],"description":"The description of the address being created\r\nMust have a maximum length of 250 characters"}}}},"components/schemas/PostKYCKeypartiesByProfileIdFailedAddKeyPartyContractResponse":{"id":"components/schemas/PostKYCKeypartiesByProfileIdFailedAddKeyPartyContractResponse","kind":"json-schema","title":"PostKYCKeypartiesByProfileIdFailedAddKeyPartyContractResponse","data":{"type":"object","properties":{"name":{"type":["string","null"],"description":"Name of the key party\r\nMaximum length is 200 characters"},"firstName":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"First name of the key party"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Valid for only entity type Individual "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Maximum length is 200 characters combining First name, Middle name and Last name"},"children":[]}]}]}]},"middleName":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Middle name of the key party"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Valid for only entity type Individual "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Maximum length is 200 characters combining First name, Middle name and Last name"},"children":[]}]}]}]},"lastName":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Last name of the key party"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Valid for only entity type Individual "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Maximum length is 200 characters combining First name, Middle name and Last name"},"children":[]}]}]}]},"entityType":{"type":["string","null"],"description":"Entity type of the key party, individual, business"},"keyPartyType":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the key party"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Valid Key Party types for entity type Individual are Director, Ubo and ShareHolder "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Valid Key Party types for entity type Business are Ubo and ShareHolder , director, shareHolder, ubo"},"children":[]}]}]}]},"gender":{"type":["string","null"],"description":"Gender of the key party\r\nValid for entity type Individual, male, female"},"dateOfBirth":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date of birth of the key party"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date YYYY-MM-DD or YYYY format. Must be after 1900 and not in the future"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Valid for the entity type Individual"},"children":[]}]}]}],"format":"date"},"organisationNumber":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Key party organisation number"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Valid for entity type Business"},"children":[]}]}]}]},"activityCode":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Activity code of the key party"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Valid for entity type Business"},"children":[]}]}]}]},"percentageOfShares":{"type":["number","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Share percentage of the key party"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Valid for key party type ShareHolder"},"children":[]}]}]}],"format":"double"},"role":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Role of the key party"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Valid for key party type Director"},"children":[]}]}]}]},"countryCode":{"type":["string","null"],"description":"Country code of the key party"},"address":{"$ref":"#/components/schemas/PostKYCKeypartiesByProfileIdAddressRequestContractResponse"}}}},"components/schemas/PostKYCKeypartiesByProfileIdFailedResponse":{"id":"components/schemas/PostKYCKeypartiesByProfileIdFailedResponse","kind":"json-schema","title":"PostKYCKeypartiesByProfileIdFailedResponse","data":{"type":"object","properties":{"failedItem":{"$ref":"#/components/schemas/PostKYCKeypartiesByProfileIdFailedAddKeyPartyContractResponse"},"error":{"$ref":"#/components/schemas/KycProtectErrorObject"}}}},"components/schemas/DeleteKeyPartiesResponseByProfileIdFailedObjectResponse":{"id":"components/schemas/DeleteKeyPartiesResponseByProfileIdFailedObjectResponse","kind":"json-schema","title":"DeleteKeyPartiesResponseByProfileIdFailedObjectResponse","data":{"type":"object","properties":{"failedItem":{"type":"string","format":"uuid"}}}},"components/schemas/DeleteKeyPartiesResponseByProfileId":{"id":"components/schemas/DeleteKeyPartiesResponseByProfileId","kind":"json-schema","title":"DeleteKeyPartiesResponseByProfileId","data":{"type":"object","properties":{"failed":{"type":"array","items":{"$ref":"#/components/schemas/DeleteKeyPartiesResponseByProfileIdFailedObjectResponse"}},"successful":{"type":"array","items":{"type":"string","format":"uuid"}}}}},"components/schemas/UpdateKeyPartyById":{"id":"components/schemas/UpdateKeyPartyById","kind":"json-schema","title":"UpdateKeyPartyById","data":{"type":"object","properties":{"name":{"type":["string","null"],"description":"Name of the key party\r\nMaximum length is 200 characters"},"firstName":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"First name of the key party"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Valid for only entity type Individual "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Maximum length is 200 characters combining First name, Middle name and Last name"},"children":[]}]}]}]},"middleName":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Middle name of the key party"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Valid for only entity type Individual "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Maximum length is 200 characters combining First name, Middle name and Last name"},"children":[]}]}]}]},"lastName":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Last name of the key party"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Valid for only entity type Individual "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Maximum length is 200 characters combining First name, Middle name and Last name"},"children":[]}]}]}]},"gender":{"type":["string","null"],"description":"Gender of the key party\r\nValid for entity type Individual (male, female)"},"dateOfBirth":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date of birth of the key party"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date YYYY-MM-DD or YYYY format. Must be after 1900 and not in the future"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Valid for the entity type Individual"},"children":[]}]}]}],"format":"date"},"organisationNumber":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Key party organisation number"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Valid for entity type Business"},"children":[]}]}]}]},"activityCode":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Activity code of the key party"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Valid for entity type Business"},"children":[]}]}]}]},"percentageOfShares":{"type":["number","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Share percentage of the key party"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Valid for key party type ShareHolder"},"children":[]}]}]}],"format":"double"},"role":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Role of the key party"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Valid for key party type Director"},"children":[]}]}]}]},"countryCode":{"type":["string","null"],"description":"Country code of the key party"},"address":{"type":"object","properties":{"buildingDetails":{"type":["string","null"],"description":"The building details of the address being created.\r\nMust have a maximum length of 250 characters"},"street":{"type":["string","null"],"description":"The street of the address being created.\r\nMust have a maximum length of 250 characters"},"city":{"type":["string","null"],"description":"The city of the address being created.\r\nMust have a maximum length of 250 characters"},"region":{"type":["string","null"],"description":"The region of the address being created.\r\nMust have a maximum length of 250 characters"},"postalCode":{"type":["string","null"],"description":"The postal code of the address being created.\r\nMust have a maximum length of 50 characters"},"countryCode":{"type":["string","null"],"description":"The country code of the address being created."},"type":{"type":["string","null"],"description":"Allowed values: registered, trading, other"},"description":{"type":["string","null"],"description":"The description of the address being created.\r\nMust have a maximum length of 250 characters"}}}}}},"components/schemas/KeyPartyByIdReturn":{"id":"components/schemas/KeyPartyByIdReturn","kind":"json-schema","title":"KeyPartyByIdReturn","data":{"type":"object","properties":{"id":{"type":"string","description":"Id of the key party","format":"uuid"},"name":{"type":"string","description":"Name of the key party"},"firstName":{"type":"string","description":"First name of the key party"},"middleName":{"type":["string","null"],"description":"Middle name of the key party"},"lastName":{"type":"string","description":"Last name of the key party"},"entityType":{"type":"string","description":"Entity type of the key party, i.e. individual, business"},"keyPartyType":{"type":"string","description":"Type of the key party, i.e. director, shareHolder, ubo"},"gender":{"type":["string","null"],"description":"Gender of the key party, i.e. male, female"},"dateOfBirth":{"type":["string","null"],"description":"Date of birth of the key party","format":"date"},"organisationNumber":{"type":["string","null"],"description":"Key party organization number"},"activityCode":{"type":["string","null"],"description":"Activity code of the key party"},"percentageOfShares":{"type":["number","null"],"description":"Share percentage of the key party","format":"double"},"role":{"type":["string","null"],"description":"Role of the key party"},"countryCode":{"type":["string","null"],"description":"Country code of the key party"},"address":{"properties":{"id":{"type":"string","description":"Id of the address","format":"uuid"},"buildingDetails":{"type":["string","null"],"description":"Building details of the address"},"street":{"type":["string","null"],"description":"Street of the address"},"city":{"type":["string","null"],"description":"City of the address"},"region":{"type":["string","null"],"description":"Region of the address"},"postalCode":{"type":["string","null"],"description":"Postalcode of the address"},"countryCode":{"type":["string","null"],"description":"Two-letter country code ISO-3166-2"},"type":{"type":"string","description":"Type of the address, i.e. registered, trading, other"},"description":{"type":["string","null"],"description":"Description of the address"},"createdAt":{"type":"string","description":"Address created date time","format":"date-time"},"createdById":{"type":"integer","description":"Id of the user who created the Address","format":"int32"},"createdBy":{"type":"string","description":"Name of the user who created the Address"},"modifiedAt":{"type":["string","null"],"description":"Address last updated date time","format":"date-time"},"modifiedById":{"type":["integer","null"],"description":"Id of the user who last modified the Address","format":"int32"},"modifiedBy":{"type":["string","null"],"description":"Name of the user who last modified the Address"}}},"searchId":{"type":["string","null"],"description":"Search Id of the key party","format":"uuid"},"createdAt":{"type":"string","description":"Key party created time","format":"date-time"},"createdById":{"type":"integer","description":"Id of the user who created the key party","format":"int32"},"createdBy":{"type":"string","description":"Name of the user who created the key party"},"modifiedAt":{"type":["string","null"],"description":"key party last updated time","format":"date-time"},"modifiedById":{"type":["integer","null"],"description":"Id of the user who last modified the key party","format":"int32"},"modifiedBy":{"type":["string","null"],"description":"Name of the user who last modified the key party"}}}},"components/schemas/DeleteKeyPartyByIdNoContent":{"id":"components/schemas/DeleteKeyPartyByIdNoContent","kind":"json-schema","title":"DeleteKeyPartyByIdNoContent","data":{"type":"object","properties":{"statusCode":{"type":"integer","format":"int32","example":0}}}},"components/schemas/GetKeyPartySearchResponse":{"id":"components/schemas/GetKeyPartySearchResponse","kind":"json-schema","title":"GetKeyPartySearchResponse","data":{"type":"object","properties":{"id":{"type":"string","description":"Id of the search","format":"uuid"},"name":{"type":["string","null"],"description":"Name provided for the search. Length must not exceed 200 characters"},"countryCodes":{"type":["array","null"],"items":{"type":"string"},"description":"Countries provided to the search"},"threshold":{"type":"integer","description":"Hits with scores below this value will not be shown.","format":"int32"},"type":{"type":"string","description":"Indicates whether search type is individual or business"},"datasets":{"type":"array","items":{"type":"string"},"description":"Provided datasets for the search"},"sanctionBodies":{"type":["array","null"],"items":{"type":"integer"},"description":"Provided sanctionBodies for the search"},"status":{"type":"string","description":"Status of the search, i.e. new, approved, declined, pending, cancelled, referred, closed"},"riskRating":{"type":"string","description":"Risk associated with the search, i.e. notApplicable, veryLow, low, medium, high, veryHigh"},"assignedToUserId":{"type":["integer","null"],"description":"Id of the user assigned to the search","format":"int32"},"assignedUser":{"type":["string","null"],"description":"Name of the user assigned to the search"},"createdById":{"type":"integer","description":"Id of the user who created the search","format":"int32"},"createdBy":{"type":"string","description":"Name of the user who created the search"},"createdAt":{"type":"string","description":"Search created date time","format":"date-time"},"modifiedById":{"type":"integer","description":"Id of the user who modified the search","format":"int32"},"modifiedBy":{"type":"string","description":"Name of the user who modified the search"},"modifiedAt":{"type":"string","description":"Search modified date time","format":"date-time"},"note":{"type":["string","null"],"description":"Note associated with the search"},"scheduleId":{"type":["string","null"],"description":"Schedule Id linked to the search","format":"uuid"},"totalHitCount":{"type":"integer","description":"Total number of hits in the search","format":"int32"},"truePositiveHitsCount":{"type":"integer","description":"The number of true-positive hits in the search","format":"int32"},"falsePositiveHitsCount":{"type":"integer","description":"The number of false-positive hits in the search","format":"int32"},"undecidedHitsCount":{"type":"integer","description":"The number of undecided hits in the search","format":"int32"},"firstName":{"type":["string","null"],"description":"First name of individual provided in the search. The combination of first name, middle name, and last name must not exceed 200 characters"},"middleName":{"type":["string","null"],"description":"Middle name of individual provided in the search. The combination of first name, middle name, and last name must not exceed 200 characters"},"lastName":{"type":["string","null"],"description":"Last name of individual provided in the search. The combination of first name, middle name, and last name must not exceed 200 characters"},"gender":{"type":["string","null"],"description":"Gender of individual provided in the search. i.e. male. female"},"dateOfBirth":{"type":["string","null"],"description":"DOB of individual provided in the search","format":"date"},"pepTiers":{"type":["array","null"],"items":{"type":"string"},"description":"Pep Tiers provided in the search of individual, i.e. pepTier1. pepTier2, pepTier3"},"keyPartyId":{"type":"string","description":"Id of the key party","format":"uuid"},"keyPartyType":{"type":"string","description":"Type of key party, i.e. director, shareHolder, ubo"},"isDobRequired":{"type":["boolean","null"],"description":"Indicates whether date of birth is required for the individual search.","default":true}}}},"components/schemas/DeleteKeyPartySearchContractRequest":{"id":"components/schemas/DeleteKeyPartySearchContractRequest","kind":"json-schema","title":"DeleteKeyPartySearchContractRequest","data":{"type":"object","properties":{"items":{"type":"array","description":"Array of objects containing key party and search IDs.","items":{"type":"object","properties":{"keyPartyId":{"type":"string","description":"Key party Id of the linked search.","format":"uuid"},"searchId":{"type":"string","description":"Search Id of the linked key party.","format":"uuid"}}}}}}},"components/schemas/DeleteKeyPartiesResponseByProfileIdFailedObjectResponseError":{"id":"components/schemas/DeleteKeyPartiesResponseByProfileIdFailedObjectResponseError","kind":"json-schema","title":"DeleteKeyPartiesResponseByProfileIdFailedObjectResponseError","data":{"type":"object","properties":{"type":{"type":["string","null"]},"title":{"type":["string","null"]},"status":{"type":["integer","null"],"format":"int32"},"detail":{"type":["string","null"]},"instance":{"type":["string","null"]}}}},"components/schemas/DeleteKeyPartySearchContractResponse":{"id":"components/schemas/DeleteKeyPartySearchContractResponse","kind":"json-schema","title":"DeleteKeyPartySearchContractResponse","data":{"type":"object","properties":{"failed":{"type":["array","null"],"items":{"type":"object","properties":{"failedItem":{"type":"object","properties":{"keyPartyId":{"type":"string","description":"key party Id of the linked search","format":"uuid"},"searchId":{"type":"string","description":"search Id of the linked key party","format":"uuid"}}},"error":{"type":"object","properties":{"type":{"type":["string","null"]},"title":{"type":["string","null"]},"status":{"type":["integer","null"],"format":"int32"},"detail":{"type":["string","null"]},"instance":{"type":["string","null"]}}}}}},"successful":{"type":["array","null"],"items":{"type":"object","properties":{"keyPartyId":{"type":"string","description":"key party Id of the linked search","format":"uuid"},"searchId":{"type":"string","description":"search Id of the linked key party","format":"uuid"}}}},"error":{"$ref":"#/components/schemas/DeleteKeyPartiesResponseByProfileIdFailedObjectResponseError"}}}},"components/schemas/AddKeyPartySearchContract":{"id":"components/schemas/AddKeyPartySearchContract","kind":"json-schema","title":"AddKeyPartySearchContract","data":{"type":"object","properties":{"type":{"type":"string","description":"The entity type of the search. Available values are individual and business."},"name":{"type":["string","null"],"description":"Required if FirstName and LastName are not provided"},"firstName":{"type":["string","null"],"description":"If FirstName is provided then LastName must also be provided"},"middleName":{"type":["string","null"],"description":"Middle name is optional, valid along with Firstname and LastName only"},"lastName":{"type":["string","null"],"description":"If LastName is provided then FirstName must also be provided"},"dateOfBirth":{"type":["string","null"],"description":"Date YYYY-MM-DD or YYYY format. Must be after 1900 and not in the future.","format":"date"},"gender":{"type":["string","null"],"description":"Define the gender of the individual you are searching for."},"pepTiers":{"type":"array","items":{"type":"string"},"description":"When searching the PEP dataset, define what tiers of the PEP profiles should be included in the results where:  \n\n  PEP Tier 1 indicates senior roles  \n  PEP Tier 2 - middle-ranking  \n  PEP Tier 3 - junior officials  \n\nIf the PEP Dataset is NOT included on the list of searched datasets, then this value is ignored. The PEP Tier filter does not apply to PEP-LINKED Profiles."},"datasets":{"type":"array","items":{"type":"string"},"description":"Specifies which datasets will be searched:  \n\n  PEP - Politically Exposed Persons (All)  \n  PEP-CURRENT - Only current PEPs  \n  PEP-FORMER - Only former PEPs  \n  PEP-LINKED - Only linked PEPs (PEP by Association)  \n  SAN - Sanctioned (All)  \n  SAN-CURRENT - Only current Sanctions  \n  SAN-FORMER - Only former Sanctions  \n  INS - Insolvency  \n  AM - Averse Media  \n  POI - Profile of Interest  \n  ENF - Enforcement  \n  DD - Disqualified Director"},"sanctionBodies":{"type":["array","null"],"description":"Specifies which SanctionBodies will be searched. When null is supplied, the Settings preferences will be applied. When null is supplied and Settings preferences not set, all sanction bodies will be applied. When no sanction bodies supplied, all sanction bodies will be applied.","items":{"type":"integer"}},"countryCodes":{"type":["array","null"],"items":{"type":"string"}},"threshold":{"type":"integer","description":"Must be one of 75, 80, 85, 90, 95, or 100","format":"int32"},"keyPartyId":{"type":"string","format":"uuid"}}}},"components/schemas/PostKYCKeypartiesSearchesLinkByProfileIdResponse":{"id":"components/schemas/PostKYCKeypartiesSearchesLinkByProfileIdResponse","kind":"json-schema","title":"PostKYCKeypartiesSearchesLinkByProfileIdResponse","data":{"type":"object","properties":{"failed":{"type":"array","items":{"type":"object","properties":{"failedItem":{"type":"object","properties":{"keyPartyId":{"type":"string","description":"Id of the key party to link to the search"},"searchId":{"type":"string","description":"Id of the search to link to the key party"}}},"error":{"type":"object","properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"number"},"detail":{"type":"string"},"instance":{"type":"string"},"additionalProp1":{"type":"string"},"additionalProp2":{"type":"string"},"additionalProp3":{"type":"string"}}}}}},"successful":{"type":"array","items":{"type":"object","properties":{"keyPartyId":{"type":"string","description":"Id of the key party to link to the search"},"searchId":{"type":"string","description":"Id of the search to link to the key party"}}}}}}},"components/schemas/GetKYCProtectProfileIdNotesResponse":{"id":"components/schemas/GetKYCProtectProfileIdNotesResponse","kind":"json-schema","title":"GetKYCProtectProfileIdNotesResponse","data":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Id of the note."},"body":{"type":"string","description":"Body of the note."},"isArchived":{"type":"boolean","description":"Value indicating whether the note is archived."},"createdAt":{"type":"string","description":"Note created time."},"createdById":{"type":"number","description":"Id of the user who created note."},"createdBy":{"type":"string","description":"Name of the user who created note."},"modifiedAt":{"type":"string","description":"Note last updated time."},"modifiedById":{"type":"number","description":"Id of the user who last modified the note."},"modifiedBy":{"type":"string","description":"Name of the user who last modified the note."},"linkedTo":{"type":["string","null"],"description":"The profile component to which current not is linked to."}}}},"totalSize":{"type":"number","description":"The total number of notes returned for the given profileId."},"correlationId":{"type":"string","description":"A unique ID assigned to this request."}}}},"components/schemas/PostKYCProfileNotesRequest":{"id":"components/schemas/PostKYCProfileNotesRequest","kind":"json-schema","title":"PostKYCProfileNotesRequest","data":{"type":"object","properties":{"body":{"type":["string","null"],"description":"The body of the note to be added. Limited to 1000 characters"}},"example":{"body":"The body of the note to be added. Limited to 1000 characters"}}},"components/schemas/PostKYCProfileNotes":{"id":"components/schemas/PostKYCProfileNotes","kind":"json-schema","title":"PostKYCProfileNotes","data":{"type":"object","properties":{"id":{"type":"string","description":"Id of the note","format":"uuid"},"body":{"type":["string","null"],"description":"Body of the note"},"isArchived":{"type":"boolean","description":"Value indicating whether the note is archived"},"createdAt":{"type":"string","description":"Note created time","format":"date-time"},"createdById":{"type":"integer","description":"Id of the user who created note","format":"int32"},"createdBy":{"type":"string","description":"Name of the user who created note"},"modifiedAt":{"type":"string","description":"Note last updated time","format":"date-time"},"modifiedById":{"type":"integer","description":"Id of the user who last modified the note","format":"int32"},"modifiedBy":{"type":["string","null"],"description":"Name of the user who last modified the note"},"correlationId":{"type":"string"}},"example":{"id":"c3966c5f-576e-4770-902b-eaab894b83d7","body":"testing","isArchived":false,"createdAt":"2023-08-08T07:32:06.4989594Z","createdById":101562008,"createdBy":"Amol","modifiedAt":"2023-08-08T07:32:06.4989594Z","modifiedById":101562008,"modifiedBy":"Amol","correlationId":"f447fa87-d538-4ccb-9bac-43084d840a12"}}},"components/schemas/GetKYCProtectProfileIdNoteIdResponse":{"id":"components/schemas/GetKYCProtectProfileIdNoteIdResponse","kind":"json-schema","title":"GetKYCProtectProfileIdNoteIdResponse","data":{"type":"object","properties":{"id":{"type":"string","description":"Id of the note."},"body":{"type":["string","null"],"description":"Body of the note."},"isArchived":{"type":"boolean","description":"Value indicating whether the note is archived."},"createdAt":{"type":"string","description":"Note created time."},"createdById":{"type":"number","description":"Id of the user who created note."},"createdBy":{"type":"string","description":"Name of the user who created note."},"modifiedAt":{"type":"string","description":"Note last updated time."},"modifiedById":{"type":"number","description":"Id of the user who last modified the note."},"modifiedBy":{"type":["string","null"],"description":"Name of the user who last modified the note."},"linkedTo":{"type":["string","null"],"description":"The profile component to which current not is linked to."},"correlationId":{"type":"string","description":"A unique ID assigned to this request."}}}},"components/schemas/PutKYCProfileNotesByNoteIdRequest":{"id":"components/schemas/PutKYCProfileNotesByNoteIdRequest","kind":"json-schema","title":"PutKYCProfileNotesByNoteIdRequest","data":{"type":"object","properties":{"body":{"type":["string","null"],"description":"The body of the note to be added. Limited to 1000 characters"},"isArchived":{"type":"boolean"}},"example":{"body":"testing","isArchived":true}}},"components/schemas/PutKYCProfileNotesByNoteId":{"id":"components/schemas/PutKYCProfileNotesByNoteId","kind":"json-schema","title":"PutKYCProfileNotesByNoteId","data":{"type":"object","properties":{"id":{"type":"string","description":"Id of the note","format":"uuid"},"body":{"type":"string","description":"Body of the note"},"isArchived":{"type":"boolean","description":"Value indicating whether the note is archived"},"createdAt":{"type":"string","description":"Note created time","format":"date-time"},"createdById":{"type":"integer","description":"Id of the user who created note","format":"int32"},"createdBy":{"type":"string","description":"Name of the user who created note"},"modifiedAt":{"type":"string","description":"Note last updated time","format":"date-time"},"modifiedById":{"type":"integer","description":"Id of the user who last modified the note","format":"int32"},"modifiedBy":{"type":"string","description":"Name of the user who last modified the note"}}}},"components/schemas/KYCProfileScheduleResponse":{"id":"components/schemas/KYCProfileScheduleResponse","kind":"json-schema","title":"KYCProfileScheduleResponse","data":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The id of the schedule","format":"uuid"},"searchId":{"type":"string","description":"The id of the search that was being scheduled","format":"uuid"},"isEmailRequired":{"type":"boolean","description":"Indicates whether the schedule requires an email to be sent when the search is run"},"emailRecipients":{"type":["array","null"],"items":{"type":"string"},"description":"The email recipients that the email should be sent to when the search is run"},"createdById":{"type":"integer","description":"The id of the user who created the schedule","format":"int32"},"createdAt":{"type":"string","description":"The time the schedule was created","format":"date-time"},"createdBy":{"type":"string","description":"The name of the user who created the schedule"},"modifiedById":{"type":"integer","description":"The id of the user who last modified the schedule","format":"int32"},"modifiedAt":{"type":"string","description":"The time the schedule was last modified","format":"date-time"},"modifiedBy":{"type":"string","description":"The name of the user who last modified the schedule"},"type":{"type":"string","description":"The type of the schedule, i.e. business or individual"},"name":{"type":["string","null"],"description":"The name used in the search criteria"},"firstName":{"type":["string","null"],"description":"The first name used in the search criteria"},"middleName":{"type":["string","null"],"description":"The middle name used in the search criteria"},"lastName":{"type":["string","null"],"description":"The last name used in the search criteria"},"gender":{"type":["string","null"],"description":"The gender used in the search criteria, i.e. male or female"},"dateOfBirth":{"type":["string","null"],"description":"The date of birth used in the search criteria","format":"date"},"countries":{"type":["array","null"],"items":{"type":"string"},"description":"The list of country codes used in the search criteria"},"threshold":{"type":"integer","description":"The threshold used in the search criteria","format":"int32"},"datasets":{"type":"array","items":{"type":"string"},"description":"The datasets used in the search criteria"},"sanctionBodies":{"type":["array","null"],"items":{"type":"integer"},"description":"Provided sanctionBodies for the search"},"pepTiers":{"type":["array","null"],"items":{"type":"string"},"description":"The pep tiers used in the search criteria, i.e. pepTier1, pepTier2, pepTier3, byAssociation"}}}},"totalSize":{"type":"number"}}}},"components/schemas/KYCProfileIdSchedulesScheduleIdResponse":{"id":"components/schemas/KYCProfileIdSchedulesScheduleIdResponse","kind":"json-schema","title":"KYCProfileIdSchedulesScheduleIdResponse","data":{"type":"object","properties":{"id":{"type":"string","description":"The id of the schedule","format":"uuid"},"searchId":{"type":"string","description":"The id of the search that was being scheduled","format":"uuid"},"isEmailRequired":{"type":"boolean","description":"Indicates whether the schedule requires an email to be sent when the search is run"},"emailRecipients":{"type":"array","description":"The email recipients that the email should be sent to when the search is run","items":{"type":"string"}},"createdById":{"type":"integer","description":"The id of the user who created the schedule","format":"int32"},"createdAt":{"type":"string","description":"The time the schedule was created","format":"date-time"},"createdBy":{"type":"string","description":"The name of the user who created the schedule"},"modifiedById":{"type":"integer","description":"The id of the user who last modified the schedule","format":"int32"},"modifiedAt":{"type":"string","description":"The time the schedule was last modified","format":"date-time"},"modifiedBy":{"type":"string","description":"The name of the user who last modified the schedule"},"type":{"type":"string","description":"The type of the schedule, i.e. business or individual"},"name":{"type":"object","description":"The name used in the search criteria"},"firstName":{"type":"object","description":"The first name used in the search criteria"},"middleName":{"type":"object","description":"The middle name used in the search criteria"},"lastName":{"type":"object","description":"The last name used in the search criteria"},"gender":{"type":"object","description":"The gender used in the search criteria, i.e. male or female"},"dateOfBirth":{"type":"object","description":"The date of birth used in the search criteria","format":"date"},"countries":{"type":"array","description":"The list of country codes used in the search criteria","items":{"type":"string"}},"threshold":{"type":"integer","description":"The threshold used in the search criteria","format":"int32"},"datasets":{"type":"array","description":"The datasets used in the search criteria","items":{"type":"string"}},"sanctionBodies":{"type":["array","null"],"items":{"type":"integer"},"description":"Provided sanctionBodies for the search"},"pepTiers":{"type":"array","description":"The pep tiers used in the search criteria, i.e. pepTier1, pepTier2, pepTier3","items":{"type":"string"}},"correlationId":{"type":"string","description":"A unique ID assigned to this request."}}}},"components/schemas/KycProtectGetSearchResponse":{"id":"components/schemas/KycProtectGetSearchResponse","kind":"json-schema","title":"KycProtectGetSearchResponse","data":{"type":"object","properties":{"id":{"type":"string","description":"Id of the search","format":"uuid"},"name":{"type":"object","description":"Name provided for the search. Length must not exceed 200 characters"},"countryCodes":{"type":"array","description":"Countries provided to the search","items":{"type":"string"}},"threshold":{"type":"integer","description":"Hits with scores below this value will not be shown.","format":"int32"},"type":{"type":"string","description":"Indicates whether search type is individual or business"},"datasets":{"type":"array","description":"Provided datasets for the search","items":{"type":"string"}},"status":{"type":"string","description":"Status of the search"},"riskRating":{"type":"string","description":"Risk associated with the search"},"assignedToUserId":{"type":"object","description":"Id of the user assigned to the search","format":"int32"},"assignedUser":{"type":"object","description":"Name of the user assigned to the search"},"createdById":{"type":"integer","description":"Id of the user who created the search","format":"int32"},"createdBy":{"type":"string","description":"Name of the user who created the search"},"createdAt":{"type":"string","description":"Search created date time","format":"date-time"},"modifiedById":{"type":"integer","description":"Id of the user who modified the search","format":"int32"},"modifiedBy":{"type":"string","description":"Name of the user who modified the search"},"modifiedAt":{"type":"string","description":"Search modified date time","format":"date-time"},"note":{"type":"object","description":"Note associated with the search"},"totalHitCount":{"type":"integer","description":"Total number of hits in the search","format":"int32"},"truePositiveHitsCount":{"type":"integer","description":"The number of true-positive hits in the search","format":"int32"},"falsePositiveHitsCount":{"type":"integer","description":"The number of false-positive hits in the search","format":"int32"},"undecidedHitsCount":{"type":"integer","description":"The number of undecided hits in the search","format":"int32"},"firstName":{"type":"object","description":"First name provided in the search.\r\nThe combination of first name, middle name, and last name must not exceed 200 characters"},"middleName":{"type":"object","description":"Middle name provided in the search.\r\nThe combination of first name, middle name, and last name must not exceed 200 characters"},"lastName":{"type":"object","description":"Last name provided in the search.\r\nThe combination of first name, middle name, and last name must not exceed 200 characters"},"gender":{"type":"object","description":"Gender provided in the search. Available values are male, female."},"dateOfBirth":{"type":"object","description":"DOB provided in the search","format":"date"},"pepTiers":{"type":"array","description":"Pep Tiers provided in the search.  Avaialable values are pepTier1, pepTier2, pepTier3.","items":{"type":"string"}},"scheduleId":{"type":"object","description":"Schedule Id linked to the search","format":"uuid"}}}},"components/schemas/DeleteKYCProfileSearchesByProfileIdRequestBody":{"id":"components/schemas/DeleteKYCProfileSearchesByProfileIdRequestBody","kind":"json-schema","title":"DeleteKYCProfileSearchesByProfileIdRequestBody","data":{"type":"object","properties":{"searchIds":{"type":"array","description":"List of searches to de-link from a profile","items":{"type":"string"},"example":["1255eebd-7f75-4163-a8b4-ab95e8f7be74"]}}}},"components/schemas/DeleteKYCProfileSearchesByProfileIdResponse":{"id":"components/schemas/DeleteKYCProfileSearchesByProfileIdResponse","kind":"json-schema","title":"DeleteKYCProfileSearchesByProfileIdResponse","data":{"type":"object","properties":{"failed":{"type":"array","items":{"type":"object","properties":{"failedItem":{"type":"string"},"error":{"type":"object","properties":{"type":{"type":["string","null"]},"title":{"type":["string","null"]},"status":{"type":["number","null"]},"detail":{"type":["string","null"]},"instance":{"type":["string","null"]},"additionalProp1":{"type":"string"},"additionalProp2":{"type":"string"},"additionalProp3":{"type":"string"}}}}}},"successful":{"type":"array","items":{"type":"string","format":"uuid"}}}}},"components/schemas/AddSearchContract":{"id":"components/schemas/AddSearchContract","kind":"json-schema","title":"AddSearchContract","data":{"type":"object","properties":{"type":{"type":"string","description":"The entity type of the search. Available values are individual and business."},"name":{"type":["string","null"],"description":"Required if FirstName and LastName are not provided"},"firstName":{"type":["string","null"],"description":"If FirstName is provided then LastName must also be provided"},"middleName":{"type":["string","null"],"description":"Middle name is optional, valid along with Firstname and LastName only"},"lastName":{"type":["string","null"],"description":"If LastName is provided then FirstName must also be provided"},"dateOfBirth":{"type":["string","null"],"description":"Date YYYY-MM-DD or YYYY format. Must be after 1900 and not in the future.","format":"date"},"gender":{"type":["string","null"],"description":"Define the gender of the individual you are searching for."},"pepTiers":{"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":"When searching the PEP dataset, define what tiers of the PEP profiles should be included in the results."},"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":" PEP Tier 1 indicates senior roles"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" PEP Tier 2 - middle-ranking"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" PEP Tier 3 - junior officials"},"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":" If the PEP Dataset is NOT included on the list of searched datasets, then this value is ignored. The PEP Tier filter does not apply to PEP-LINKED Profiles."},"children":[]}]}]}]},"datasets":{"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":"Specifies which datasets will be searched"},"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":" PEP - Politically Exposed Persons (All)"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" PEP-CURRENT - Only current PEPs"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" PEP-FORMER - Only former PEPs PEP-LINKED - Only linked PEPs (PEP by Association)"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" SAN - Sanctioned (All)"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" SAN-CURRENT - Only current Sanctions"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" SAN-FORMER - Only former Sanctions"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" INS - Insolvency "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" AM - Averse Media"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" POI - Profile of Interest"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ENF - Enforcement "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" DD - Disqualified Director"},"children":[]}]}]}]},"sanctionBodies":{"type":["array","null"],"description":"Specifies which SanctionBodies will be searched. When null is supplied, the Settings preferences will be applied. When null is supplied and Settings preferences not set, all sanction bodies will be applied. When no sanction bodies supplied, all sanction bodies will be applied.","items":{"type":"integer"}},"countryCodes":{"type":["array","null"],"items":{"type":"string"}},"threshold":{"type":"integer","description":"Must be one of 75, 80, 85, 90, 95, or 100","format":"int32"}}}},"components/schemas/KycProtectProblemDetails":{"id":"components/schemas/KycProtectProblemDetails","kind":"json-schema","title":"KycProtectProblemDetails","data":{"type":"object","properties":{"type":{"type":["string","null"]},"title":{"type":["string","null"]},"status":{"type":["integer","null"],"format":"int32"},"detail":{"type":["string","null"]},"instance":{"type":["string","null"]}}}},"components/schemas/KYCProtectProfileAlertsMetricsResponse":{"id":"components/schemas/KYCProtectProfileAlertsMetricsResponse","kind":"json-schema","title":"KYCProtectProfileAlertsMetricsResponse","data":{"type":"object","properties":{"profileId":{"description":"Id of the Profile","type":"string","format":"uuid"},"profileName":{"description":"Name of the Profile","type":"string"},"internalId":{"description":"Internal Id of the Profile","type":["string","null"]},"undecidedSearchHitsCount":{"description":"Count of search hits that are in Undecided state that are associated to profile","type":"integer","format":"int32"},"openKycAlertsCount":{"description":"Count of kyc alerts that are in Open state that are associated to profile","type":"integer","format":"int32"},"latestAlertCreatedAt":{"description":"The Latest alert created date and time that associated to profile","type":"string","format":"date-time"},"latestMonitoringUpdaterRunAt":{"description":"The Latest monitoring updater run date and time","type":["string","null"],"format":"date-time"}}}},"components/schemas/PutKYCProfileAssign":{"id":"components/schemas/PutKYCProfileAssign","kind":"json-schema","title":"PutKYCProfileAssign","data":{"type":"object","properties":{"id":{"type":"string","description":"Id of the Profile","format":"uuid"},"name":{"type":"string","description":"Name of the Profile"},"riskRating":{"type":"string","description":"The risk rating being assigned to the profile","enum":["notApplicable","veryLow","low","medium","high","veryHigh"]},"status":{"type":"string","description":"Status of the profile (new, approved, declined, pending, cancelled, referred, closed, approvedReviewDue)"},"type":{"type":"string","description":"Type of the profile (trust, individual, soleTrader, company, plc, partnership, otherEntity)"},"internalId":{"type":"string","description":"Internal Id given to profile by customer"},"assignedToId":{"type":"integer","description":"Id of the user assigned to the profile"},"assignedTo":{"type":"string","description":"Name of the user assigned to the profile"},"safeNumber":{"type":"string","description":"safe number of the business linked to the profile"},"companyId":{"type":"string","description":"company id of the business linked to the profile"},"formationDate":{"type":"string","description":"Formation date of the business linked to the profile","format":"date"},"createdAt":{"type":"string","description":"Profile created time","format":"date-time"},"createdById":{"type":"integer","description":"Id of the user who created the profile","format":"int32"},"createdBy":{"type":"string","description":"Name of the user who created the profile"},"modifiedAt":{"type":["string","null"],"description":"Profile last updated time","format":"date-time"},"modifiedById":{"type":"integer","description":"Id of the user who last modified the profile","format":"int32"},"modifiedBy":{"type":"string","description":"Name of the user who last modified the profile"},"kycApprovedAt":{"type":"string","description":"Date when the profile got approved","format":"date-time"},"kycReviewOn":{"type":"string","description":"Date when profile is to be reviewed","format":"date"},"kycStatusUpdatedOn":{"type":"string","description":"Date when the profile status was last updated","format":"date-time"},"kycComments":{"type":"string","description":"Profile comments"},"noteCount":{"type":"integer","description":"Count of notes associated with profile","format":"int32"},"attachmentCount":{"type":"integer","description":"Count of attachments associated with profile","format":"int32"},"keyPartyCount":{"type":"integer","description":"Count of key parties associated with profile","format":"int32"},"uboCount":{"type":"integer","description":"Count of UBOs associated with profile","format":"int32"},"openAlertCount":{"type":"integer","description":"Count of Open Alerts","format":"int32"},"modeOfCreation":{"type":"string","description":"Mode of profile creation (manual, import)"},"importStatus":{"type":"string","description":"Status of profile creation (submitted, preprocessed, validated, queued, inProgress, processed, completed, partiallyCompleted, failed)"},"isLocked":{"type":"boolean","description":"Value indicating whether the profile is locked"},"isKycMonitored":{"type":"boolean","description":"Value indicating whether the profile is under KYC monitoring"},"correlationId":{"type":"string"}}}},"components/schemas/MODEL4df4ca":{"id":"components/schemas/MODEL4df4ca","kind":"json-schema","title":"MODEL4df4ca","data":{"type":"object","required":["profileIds"],"properties":{"userId":{"type":"integer","description":"Id of the User to assign the Profiles. Passing null will unassign the profile","format":"int32"},"profileIds":{"type":"array","description":"List of profiles to assign a user","items":{"type":"string","format":"uuid"}}}}},"components/schemas/KycProtectProfileAssignBulkResponse":{"id":"components/schemas/KycProtectProfileAssignBulkResponse","kind":"json-schema","title":"KycProtectProfileAssignBulkResponse","data":{"type":"object","properties":{"id":{"type":"string","description":"Id of the Profile","format":"uuid"},"name":{"type":"string","description":"Name of the Profile"},"riskRating":{"type":"string","description":"Risk rating given to profile. Available values are notApplicable, veryLow, low, medium, high and veryHigh."},"status":{"type":"string","description":"Status of the profile. Available values are new, approved, declined, pending, cancelled, referred, closed and approvedReviewDue."},"type":{"type":"string","description":"Type of the profile. Available values are trust, individual, soleTrader, company, plc, partnership and otherEntity."},"internalId":{"type":"object","description":"Internal Id given to profile by customer"},"assignedToId":{"type":"object","description":"Id of the user assigned to the profile","format":"int32"},"assignedTo":{"type":"object","description":"Name of the user assigned to the profile"},"safeNumber":{"type":"object","description":"safe number of the business linked to the profile"},"companyId":{"type":"object","description":"company id of the business linked to the profile"},"formationDate":{"type":"object","description":"Formation date of the business linked to the profile","format":"date"},"createdAt":{"type":"string","description":"Profile created time","format":"date-time"},"createdById":{"type":"integer","description":"Id of the user who created the profile","format":"int32"},"createdBy":{"type":"string","description":"Name of the user who created the profile"},"modifiedAt":{"type":"object","description":"Profile last updated time","format":"date-time"},"modifiedById":{"type":"object","description":"Id of the user who last modified the profile","format":"int32"},"modifiedBy":{"type":"object","description":"Name of the user who last modified the profile"},"kycApprovedAt":{"type":"string","description":"Date when the profile got approved","format":"date-time"},"kycReviewOn":{"type":"object","description":"Date when profile is to be reviewed","format":"date"},"kycStatusUpdatedOn":{"type":"object","description":"Date when the profile status was last updated","format":"date-time"},"kycComments":{"type":"object","description":"Profile comments"},"noteCount":{"type":"integer","description":"Count of notes associated with profile","format":"int32"},"attachmentCount":{"type":"integer","description":"Count of attachments associated with profile","format":"int32"},"keyPartyCount":{"type":"integer","description":"Count of key parties associated with profile","format":"int32"},"uboCount":{"type":"integer","description":"Count of UBOs associated with profile","format":"int32"},"openAlertCount":{"type":"integer","description":"Count of Open Alerts","format":"int32"},"modeOfCreation":{"type":"string","description":"Mode of profile creation. Available values are manual, import and batchUpload."},"importStatus":{"type":"object","description":"Status of profile creation. Available values are submitted, preprocessed, validated, queued, inProgress, processed, completed, partiallyCompleted and failed."},"isLocked":{"type":"boolean","description":"Value indicating whether the profile is locked"},"isKycMonitored":{"type":"boolean","description":"Value indicating whether the profile is kyc monitored"},"correlationId":{"type":"string"}}}},"components/schemas/PostKYCProfileImportBusinessesRequest":{"id":"components/schemas/PostKYCProfileImportBusinessesRequest","kind":"json-schema","title":"PostKYCProfileImportBusinessesRequest","data":{"type":"object","additionalProperties":false,"properties":{"profileName":{"type":"string","description":"Name of the profile."},"companyId":{"type":"string","description":"The primary Company identifier that is used to uniquely identify all companies across Creditsafes Universe and Partner Network."},"internalId":{"type":["string","null"],"description":"Internal Id of the profile"}},"required":["profileName","companyId"]}},"components/schemas/GetKYCProfileTypes":{"id":"components/schemas/GetKYCProfileTypes","kind":"json-schema","title":"GetKYCProfileTypes","data":{"type":"array","items":{"type":"string","example":"trust"}}},"components/schemas/GetKycProtectReportsResponse":{"id":"components/schemas/GetKycProtectReportsResponse","kind":"json-schema","title":"GetKycProtectReportsResponse","data":{"type":"object","properties":{"items":{"type":"array"},"totalSize":{"description":"The total number of reports available.","type":"integer"},"correlationId":{"type":"string","description":"Unique identifier for tracking the request, useful for debugging and tracing."}}}},"components/schemas/PostKycProtectReportsRequest":{"id":"components/schemas/PostKycProtectReportsRequest","kind":"json-schema","title":"PostKycProtectReportsRequest","data":{"type":"object","properties":{"type":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the report (e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amlAlert"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"audit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},"fileName":{"type":["string","null"],"description":"File name for the report to be created. This must be unique."},"criteria":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The criteria used to create the report. These fields should match those provided by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /criteria/{type}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}],"properties":{"additionalProperties":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional fields specific to the report type ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amlAlert"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"audit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") that customize the report's scope  and contents."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" These properties are dynamically generated and may include nested objects or arrays  for complex criteria. For example:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amlAlert"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", this may include parameters like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hitDecisions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hasHits"},"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":" - For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"audit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", this may include date ranges or detailed filtering options."},"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":" Refer to the response from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /criteria/{type}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint for a complete list of possible fields."},"children":[]}]}]}]}}}}}},"components/schemas/PostKycProtectReportResponse":{"id":"components/schemas/PostKycProtectReportResponse","kind":"json-schema","title":"PostKycProtectReportResponse","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the report, generated when the report is created."},"fileName":{"type":"string","description":"The name of the report file, as specified during creation or generated automatically."},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Current processing status of the report. Indicates the lifecycle stage, such as:"},"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":"submitted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The report request has been submitted."},"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":"queued"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The report is waiting to be processed."},"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":"inProgress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The report is currently being generated."},"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":"completed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The report has been successfully created."},"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":"failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The report generation encountered an error."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]}],"enum":["submitted","queued","inProgress","completed","failed"]},"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 report, determining the data and format of the results. Supported values:"},"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":"amlAlert"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Report for Anti-Money Laundering alerts."},"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":"audit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Report for audit-related compliance checks."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]}],"enum":["amlAlert","audit"]},"createdAt":{"type":"string","format":"date-time","description":"The timestamp when the report was initially created."},"createdById":{"type":"integer","format":"int32","description":"The unique identifier of the user who initiated the creation of the report."},"createdByUser":{"type":"string","description":"The username or identifier of the user who created the report."},"modifiedAt":{"type":"string","format":"date-time","description":"The timestamp of the last modification made to the report, if applicable."},"criteria":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The criteria used to generate the report, reflecting the filters and parameters applied during its creation."},"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":" The structure of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"criteria"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object depends on the report "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amlAlert"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"audit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Some properties may be nested in arrays or objects."},"children":[]}]}]}],"properties":{"fromDate":{"type":"string","format":"date","description":"The starting date for the report's criteria, defining the range of data included."},"toDate":{"type":"string","format":"date","description":"The ending date for the report's criteria. Results exclude this date."}},"additionalProperties":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional fields applicable to the specific report type. These may vary depending on whether the report  type is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amlAlert"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"audit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Nested arrays and objects are supported for complex criteria."},"children":[]}]}]}],"type":"object"}},"expiresAt":{"type":["string","null"],"format":"date-time","description":"The expiration timestamp for the report, after which it may no longer be accessible."},"correlationId":{"type":"string","description":"Unique identifier for tracking the request, useful for debugging and tracing."}}}},"components/schemas/GetKycProtectReportsResponseByReportId":{"id":"components/schemas/GetKycProtectReportsResponseByReportId","kind":"json-schema","title":"GetKycProtectReportsResponseByReportId","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the report, generated when the report is created."},"fileName":{"type":"string","description":"The name of the report file, as specified during creation or generated automatically."},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Current processing status of the report. Indicates the lifecycle stage, such as:"},"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":"submitted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The report request has been submitted."},"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":"queued"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The report is waiting to be processed."},"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":"inProgress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The report is currently being generated."},"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":"completed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The report has been successfully created."},"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":"failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The report generation encountered an error."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]}],"enum":["submitted","queued","inProgress","completed","failed"]},"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 report, determining the data and format of the results. Supported values:"},"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":"amlAlert"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Report for Anti-Money Laundering alerts."},"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":"audit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Report for audit-related compliance checks."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]}],"enum":["amlAlert","audit"]},"createdAt":{"type":"string","format":"date-time","description":"The timestamp when the report was initially created."},"createdById":{"type":"integer","format":"int32","description":"The unique identifier of the user who initiated the creation of the report."},"createdByUser":{"type":"string","description":"The username or identifier of the user who created the report."},"modifiedAt":{"type":"string","format":"date-time","description":"The timestamp of the last modification made to the report, if applicable."},"criteria":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The criteria used to generate the report, reflecting the filters and parameters applied during its creation."},"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":" The structure of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"criteria"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object depends on the report "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amlAlert"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"audit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":").  Some properties may be nested in arrays or objects."},"children":[]}]}]}],"properties":{"fromDate":{"type":"string","format":"date","description":"The starting date for the report's criteria, defining the range of data included."},"toDate":{"type":"string","format":"date","description":"The ending date for the report's criteria. Results exclude this date."}},"additionalProperties":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional fields applicable to the specific report type. These may vary depending on whether the report  type is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amlAlert"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"audit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Nested arrays and objects are supported for complex criteria."},"children":[]}]}]}],"type":"object"}},"expiresAt":{"type":["string","null"],"format":"date-time","description":"The expiration timestamp for the report, after which it may no longer be accessible."},"correlationId":{"type":"string","description":"Unique identifier for tracking the request, useful for debugging and tracing."}}}},"components/schemas/ScheduleResponse":{"id":"components/schemas/ScheduleResponse","kind":"json-schema","title":"ScheduleResponse","data":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The id of the schedule","format":"uuid"},"searchId":{"type":"string","description":"The id of the search that was being scheduled","format":"uuid"},"isEmailRequired":{"type":"boolean","description":"Indicates whether the schedule requires an email to be sent when the search is run"},"emailRecipients":{"type":"array","items":{"type":"string"},"description":"The email recipients that the email should be sent to when the search is run"},"createdById":{"type":"integer","description":"The id of the user who created the schedule","format":"int32"},"createdAt":{"type":"string","description":"The time the schedule was created","format":"date-time"},"createdBy":{"type":"string","description":"The name of the user who created the schedule"},"modifiedById":{"type":"integer","description":"The id of the user who last modified the schedule","format":"int32"},"modifiedAt":{"type":"string","description":"The time the schedule was last modified","format":"date-time"},"modifiedBy":{"type":"string","description":"The name of the user who last modified the schedule"},"type":{"type":"string","description":"The type of the schedule, i.e. business or individual"},"name":{"type":"string","description":"The name used in the search criteria"},"firstName":{"type":"string","description":"The first name used in the search criteria"},"middleName":{"type":"string","description":"The middle name used in the search criteria"},"lastName":{"type":"string","description":"The last name used in the search criteria"},"gender":{"type":"string","description":"The gender used in the search criteria, i.e. male or female"},"dateOfBirth":{"type":"string","description":"The date of birth used in the search criteria","format":"date"},"countries":{"type":"array","items":{"type":"string"},"description":"The list of country codes used in the search criteria"},"threshold":{"type":"integer","description":"The threshold used in the search criteria","format":"int32"},"datasets":{"type":"array","items":{"type":"string"},"description":"The datasets used in the search criteria"},"sanctionBodies":{"type":["array","null"],"items":{"type":"integer"},"description":"Provided sanctionBodies for the search"},"pepTiers":{"type":"array","items":{"type":"string"},"description":"The pep tiers used in the search criteria"},"isDobRequired":{"type":["boolean","null"],"description":"Indicates whether date of birth is required for the individual search.","default":true}}}},"totalSize":{"type":"number"}}}},"components/schemas/MODEL1e2683":{"id":"components/schemas/MODEL1e2683","kind":"json-schema","title":"MODEL1e2683","data":{"type":"object","properties":{"items":{"type":"array","description":"","items":{"type":"object","properties":{"threshold":{"type":"integer","description":"The threshold to use when running the schedule. Must be one of 75, 80, 85, 90, 95, 100.\r\nChanging threshold will cause even decided results to come back again and a new\r\ndecision will need to be made.","format":"int32"},"datasets":{"type":"array","description":"The datasets to use when running the schedule.\r\nChanging datasets will cause even decided results to come back again and a new\r\ndecision will need to be made.","items":{"type":"string"}},"sanctionBodies":{"type":["array","null"],"description":"Specifies which SanctionBodies will be searched. When null is supplied, the Settings preferences will be applied. When null is supplied and Settings preferences not set, all sanction bodies will be applied. When no sanction bodies supplied, all sanction bodies will be applied.","items":{"type":"integer"}},"isEmailRequired":{"type":"boolean","description":"Set to true to send an email when the schedule is run. If there are no email recipients set then\r\nthis will be ignored."},"emailRecipients":{"type":"array","description":"The list of email recipients to send the email to when the schedule is run. Email will not be sent IsEmailRequired is false.","items":{"type":"string"}},"scheduleId":{"type":"string","description":"The id of the schedule to be updated","format":"uuid"}}}}}}},"components/schemas/PutKYCProtectSchedulesResponse":{"id":"components/schemas/PutKYCProtectSchedulesResponse","kind":"json-schema","title":"PutKYCProtectSchedulesResponse","data":{"type":"object","properties":{"failed":{"type":"array","items":{"type":"object","properties":{"failedItem":{"type":"object","properties":{"threshold":{"type":"integer","description":"The threshold to use when running the schedule. Must be one of 75, 80, 85, 90, 95, 100.\r\nChanging threshold will cause even decided results to come back again and a new\r\ndecision will need to be made.","format":"int32"},"datasets":{"type":"array","description":"The datasets to use when running the schedule.\r\nChanging datasets will cause even decided results to come back again and a new\r\ndecision will need to be made.","items":{"type":"string"}},"isEmailRequired":{"type":"boolean","description":"Set to true to send an email when the schedule is run. If there are no email recipients set then\r\nthis will be ignored."},"emailRecipients":{"type":"array","description":"The list of email recipients to send the email to when the schedule is run. Email will not be sent if IsEmailRequired is false.","items":{"type":"string"}},"scheduleId":{"type":"string","description":"The id of the schedule to be updated","format":"uuid"}}},"error":{"type":"object","properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"integer","format":"int32"},"detail":{"type":"string"},"instance":{"type":"string"}}}}}},"successful":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The id of the schedule","format":"uuid"},"searchId":{"type":"string","description":"The id of the search that was being scheduled","format":"uuid"},"isEmailRequired":{"type":"boolean","description":"Indicates whether the schedule requires an email to be sent when the search is run"},"emailRecipients":{"type":"array","description":"The email recipients that the email should be sent to when the search is run","items":{"type":"string"}},"createdById":{"type":"integer","description":"The id of the user who created the schedule","format":"int32"},"createdAt":{"type":"string","description":"The time the schedule was created","format":"date-time"},"createdBy":{"type":"string","description":"The name of the user who created the schedule"},"modifiedById":{"type":"integer","description":"The id of the user who last modified the schedule","format":"int32"},"modifiedAt":{"type":"string","description":"The time the schedule was last modified","format":"date-time"},"modifiedBy":{"type":"string","description":"The name of the user who last modified the schedule"},"type":{"type":"string","description":"The type of the schedule, i.e. business or individual"},"name":{"type":"string","description":"The name used in the search criteria"},"firstName":{"type":"string","description":"The first name used in the search criteria"},"middleName":{"type":"string","description":"The middle name used in the search criteria"},"lastName":{"type":"string","description":"The last name used in the search criteria"},"gender":{"type":"string","description":"The gender used in the search criteria, i.e. male or female"},"dateOfBirth":{"type":"string","description":"The date of birth used in the search criteria","format":"date"},"countries":{"type":"array","description":"The list of country codes used in the search criteria","items":{"type":"string"}},"threshold":{"type":"integer","description":"The threshold used in the search criteria","format":"int32"},"datasets":{"type":"array","description":"The datasets used in the search criteria","items":{"type":"string"}},"pepTiers":{"type":"array","description":"The pep tiers used in the search criteria, i.e. pepTier1, pepTier2, pepTier3","items":{"type":"string"}},"isDobRequired":{"type":["boolean","null"],"description":"Indicates whether date of birth is required for the individual search.","default":true}}}},"correlationId":{"type":"string","description":"A unique ID assigned to this request."}}}},"components/schemas/PostKYCProtectSchedulesRequest":{"id":"components/schemas/PostKYCProtectSchedulesRequest","kind":"json-schema","title":"PostKYCProtectSchedulesRequest","data":{"type":"object","properties":{"threshold":{"type":"integer","description":"The threshold to use when running the schedule. Must be one of 75, 80, 85, 90, 95, 100.\r\nChanging threshold will cause even decided results to come back again and a new\r\ndecision will need to be made.","format":"int32"},"datasets":{"type":"array","items":{"type":"string"},"description":"The datasets to use when running the schedule.\r\nChanging datasets will cause even decided results to come back again and a new\r\ndecision will need to be made."},"sanctionBodies":{"type":["array","null"],"description":"Specifies which SanctionBodies will be searched. When null is supplied, the Settings preferences will be applied. When null is supplied and Settings preferences not set, all sanction bodies will be applied. When no sanction bodies supplied, all sanction bodies will be applied.","items":{"type":"integer"}},"isEmailRequired":{"type":"boolean","description":"Set to true to send an email when the schedule is run. If there are no email recipients set then\r\nthis will be ignored."},"emailRecipients":{"type":["array","null"],"items":{"type":"string"},"description":"The list of email recipients to send the email to when the schedule is run. Email will not be sent if IsEmailRequired is false."},"searchId":{"type":"string","description":"The id of the search to be scheduled","format":"uuid"},"isDobRequired":{"type":["boolean","null"],"description":"IsDobRequired is optional field and default value is false, valid along with dob only.","default":false}}}},"components/schemas/PostKYCProtectSchedulesResponse":{"id":"components/schemas/PostKYCProtectSchedulesResponse","kind":"json-schema","title":"PostKYCProtectSchedulesResponse","data":{"type":"object","properties":{"failed":{"type":"array","items":{"type":"object","properties":{"failedItem":{"$ref":"#/components/schemas/PostKYCProtectSchedulesRequest"},"error":{"$ref":"#/components/schemas/KycProtectErrorObject"}}}},"successful":{"type":"array","items":{"$ref":"#/components/schemas/ScheduleResponse"}}}}},"components/schemas/DeleteKYCProtectSchedulesResponse":{"id":"components/schemas/DeleteKYCProtectSchedulesResponse","kind":"json-schema","title":"DeleteKYCProtectSchedulesResponse","data":{"type":"object","properties":{"failed":{"type":"array","items":{"type":"object","properties":{"failedItem":{"type":"string","format":"uuid"},"error":{"$ref":"#/components/schemas/KycProtectErrorObject"}}}},"successful":{"type":"array","items":{"type":"string","format":"uuid"}}}}},"components/schemas/MODEL6bcc20":{"id":"components/schemas/MODEL6bcc20","kind":"json-schema","title":"MODEL6bcc20","data":{"type":"object","properties":{"threshold":{"type":"integer","description":"The threshold to use when running the schedule. Must be one of 75, 80, 85, 90, 95, 100.\r\nChanging threshold will cause even decided results to come back again and a new\r\ndecision will need to be made.","format":"int32"},"datasets":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The datasets to use when running the schedule."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Changing datasets will cause even decided results to come back again and a new"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"decision will need to be made."},"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: Please refer to the corresponding endpoint that the schedule is set against for the correct dataset options"},"children":[]}]}]}],"items":{"type":"string"}},"sanctionBodies":{"type":["array","null"],"description":"Specifies which SanctionBodies will be searched. When null is supplied, the Settings preferences will be applied. When null is supplied and Settings preferences not set, all sanction bodies will be applied. When no sanction bodies supplied, all sanction bodies will be applied.","items":{"type":"integer"}},"isEmailRequired":{"type":"boolean","description":"Set to true to send an email when the schedule is run. If there are no email recipients set then\r\nthis will be ignored."},"emailRecipients":{"type":"array","description":"The list of email recipients to send the email to when the schedule is run. Email will not be sent if IsEmailRequired is false.","items":{"type":"string"}}}}},"components/schemas/KycProtectGetIndividualSearchItems":{"id":"components/schemas/KycProtectGetIndividualSearchItems","kind":"json-schema","title":"KycProtectGetIndividualSearchItems","data":{"type":"object","properties":{"id":{"type":"string","description":"Id of the search","format":"uuid"},"name":{"type":["string","null"],"description":"Name provided for the search. Length must not exceed 200 characters"},"countryCodes":{"type":["array","null"],"items":{"type":"string"},"description":"Countries provided to the search"},"threshold":{"type":"integer","description":"Hits with scores below this value will not be shown.","format":"int32"},"type":{"type":"string","description":"Indicates whether search type is individual or business. Available values are individual, business."},"datasets":{"type":"array","items":{"type":"string"},"description":"Provided datasets for the search"},"sanctionBodies":{"type":["array","null"],"items":{"type":"integer"},"description":"Provided sanctionBodies for the search"},"status":{"type":"string","description":"Status of the search. Available values are new, approved, declined, pending, cancelled, referred, closed."},"riskRating":{"type":"string","description":"Risk associated with the search. Available values are notApplicable, veryLow, low, medium, high, veryHigh."},"assignedToUserId":{"type":["integer","null"],"description":"Id of the user assigned to the search","format":"int32"},"assignedUser":{"type":["string","null"],"description":"Name of the user assigned to the search"},"createdById":{"type":"integer","description":"Id of the user who created the search","format":"int32"},"createdBy":{"type":"string","description":"Name of the user who created the search"},"createdAt":{"type":"string","description":"Search created date time","format":"date-time"},"modifiedById":{"type":"integer","description":"Id of the user who modified the search","format":"int32"},"modifiedBy":{"type":"string","description":"Name of the user who modified the search"},"modifiedAt":{"type":"string","description":"Search modified date time","format":"date-time"},"note":{"type":["string","null"],"description":"Note associated with the search"},"scheduleId":{"type":["string","null"],"description":"Schedule Id linked to the search","format":"uuid"},"totalHitCount":{"type":"integer","description":"Total number of hits in the search","format":"int32"},"truePositiveHitsCount":{"type":"integer","description":"The number of true-positive hits in the search","format":"int32"},"falsePositiveHitsCount":{"type":"integer","description":"The number of false-positive hits in the search","format":"int32"},"undecidedHitsCount":{"type":"integer","description":"The number of undecided hits in the search","format":"int32"},"firstName":{"type":["string","null"],"description":"First name of individual provided in the search.\r\nThe combination of first name, middle name, and last name must not exceed 200 characters"},"middleName":{"type":["string","null"],"description":"Middle name of individual provided in the search.\r\nThe combination of first name, middle name, and last name must not exceed 200 characters"},"lastName":{"type":["string","null"],"description":"Last name of individual provided in the search.\r\nThe combination of first name, middle name, and last name must not exceed 200 characters"},"gender":{"type":["string","null"],"description":"Gender of individual provided in the search. Available values are male, female."},"dateOfBirth":{"type":["string","null"],"description":"DOB of individual provided in the search","format":"date"},"pepTiers":{"type":["array","null"],"items":{"type":"string"},"description":"Pep Tiers provided in the search of individual. Available values are pepTier1, pepTier2, pepTier3, byAssociation"},"isDobRequired":{"type":["boolean","null"],"description":"Indicates whether date of birth is required for the individual search.","default":true}}}},"components/schemas/KycProtectGetIndividualSearchResponse":{"id":"components/schemas/KycProtectGetIndividualSearchResponse","kind":"json-schema","title":"KycProtectGetIndividualSearchResponse","data":{"type":"object","properties":{"totalSize":{"type":"integer","format":"int32"},"items":{"type":"array","items":{"$ref":"#/components/schemas/KycProtectGetIndividualSearchItems"}}}}},"components/schemas/MODELf73bb1":{"id":"components/schemas/MODELf73bb1","kind":"json-schema","title":"MODELf73bb1","data":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Id of the search","format":"uuid"},"name":{"type":["string","null"],"description":"Name provided for the search. Length must not exceed 200 characters"},"countryCodes":{"type":["array","null"],"description":"Countries provided to the search","items":{"type":"string"}},"threshold":{"type":"integer","description":"Hits with scores below this value will not be shown.","format":"int32"},"type":{"type":"string","description":"Indicates whether search type is individual or business"},"datasets":{"type":"array","description":"Provided datasets for the search","items":{"type":"string"}},"sanctionBodies":{"type":["array","null"],"items":{"type":"integer"},"description":"Provided sanctionBodies for the search"},"status":{"type":"string","description":"Status of the search. Available values are new, approved, declined, pending, cancelled, referred and closed."},"riskRating":{"type":"string","description":"Risk associated with the search. Available values are notApplicable, veryLow, low, medium, high AND veryHigh."},"assignedToUserId":{"type":["integer","null"],"description":"Id of the user assigned to the search","format":"int32"},"assignedUser":{"type":["string","null"],"description":"Name of the user assigned to the search"},"createdById":{"type":"integer","description":"Id of the user who created the search","format":"int32"},"createdBy":{"type":"string","description":"Name of the user who created the search"},"createdAt":{"type":"string","description":"Search created date time","format":"date-time"},"modifiedById":{"type":"integer","description":"Id of the user who modified the search","format":"int32"},"modifiedBy":{"type":"string","description":"Name of the user who modified the search"},"modifiedAt":{"type":"string","description":"Search modified date time","format":"date-time"},"note":{"type":["string","null"],"description":"Note associated with the search"},"scheduleId":{"type":["string","null"],"description":"Schedule Id linked to the search","format":"uuid"},"totalHitCount":{"type":"integer","description":"Total number of hits in the search","format":"int32"},"truePositiveHitsCount":{"type":"integer","description":"The number of true-positive hits in the search","format":"int32"},"falsePositiveHitsCount":{"type":"integer","description":"The number of false-positive hits in the search","format":"int32"},"undecidedHitsCount":{"type":"integer","description":"The number of undecided hits in the search","format":"int32"}}}},"totalSize":{"type":"number"}}}},"components/schemas/KYCPUTSearchBusinessesResponse":{"id":"components/schemas/KYCPUTSearchBusinessesResponse","kind":"json-schema","title":"KYCPUTSearchBusinessesResponse","data":{"type":"object","properties":{"failed":{"type":"array","items":{"type":"object","properties":{"failedItem":{"type":"object","properties":{"assignedToUserId":{"type":["integer","null"],"description":"Id of the User to assign to the Search","format":"int32"},"status":{"type":["string","null"],"description":"Status of the Search. Available values are new, approved, declined, pending, cancelled, referred and closed."},"riskRating":{"type":["string","null"],"description":"Risk rating of the Search. Available values are notApplicable, veryLow, low, medium, high AND veryHigh."},"note":{"type":["string","null"],"description":"Note associated with the search"},"searchId":{"type":"string","description":"The Id of the search to be updated","format":"uuid"}}},"error":{"type":"object","properties":{"type":{"type":["string","null"]},"title":{"type":["string","null"]},"status":{"type":["integer","null"]},"detail":{"type":["string","null"]},"instance":{"type":["string","null"]}}}}}},"successful":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Id of the search","format":"uuid"},"name":{"type":["string","null"],"description":"Name provided for the search. Length must not exceed 200 characters"},"countryCodes":{"type":["array","null"],"description":"Countries provided to the search","items":{"type":"string"}},"threshold":{"type":"integer","description":"Hits with scores below this value will not be shown.","format":"int32"},"type":{"type":"string","description":"Indicates whether search type is individual or business"},"datasets":{"type":"array","description":"Provided datasets for the search","items":{"type":"string"}},"status":{"type":"string","description":"Status of the search. Available values are new, approved, declined, pending, cancelled, referred and closed."},"riskRating":{"type":"string","description":"Risk associated with the search. Available values are notApplicable, veryLow, low, medium, high AND veryHigh."},"assignedToUserId":{"type":["integer","null"],"description":"Id of the user assigned to the search","format":"int32"},"assignedUser":{"type":["string","null"],"description":"Name of the user assigned to the search"},"createdById":{"type":"integer","description":"Id of the user who created the search","format":"int32"},"createdBy":{"type":"string","description":"Name of the user who created the search"},"createdAt":{"type":"string","description":"Search created date time","format":"date-time"},"modifiedById":{"type":"integer","description":"Id of the user who modified the search","format":"int32"},"modifiedBy":{"type":"string","description":"Name of the user who modified the search"},"modifiedAt":{"type":"string","description":"Search modified date time","format":"date-time"},"note":{"type":["string","null"],"description":"Note associated with the search"},"scheduleId":{"type":["string","null"],"description":"Schedule Id linked to the search","format":"uuid"},"totalHitCount":{"type":"integer","description":"Total number of hits in the search","format":"int32"},"truePositiveHitsCount":{"type":"integer","description":"The number of true-positive hits in the search","format":"int32"},"falsePositiveHitsCount":{"type":"integer","description":"The number of false-positive hits in the search","format":"int32"},"undecidedHitsCount":{"type":"integer","description":"The number of undecided hits in the search","format":"int32"}}}}}}},"components/schemas/MODEL931a1b":{"id":"components/schemas/MODEL931a1b","kind":"json-schema","title":"MODEL931a1b","data":{"type":"object","properties":{"id":{"type":"string","description":"Id of the search","format":"uuid"},"name":{"type":"string","description":"Name provided for the search. Length must not exceed 200 characters"},"countryCodes":{"type":"array","description":"Countries provided to the search","items":{"type":"string"}},"threshold":{"type":"integer","description":"Hits with scores below this value will not be shown.","format":"int32"},"type":{"type":"string","description":"Indicates whether search type is individual or business"},"datasets":{"type":"array","description":"Provided datasets for the search","items":{"type":"string"}},"status":{"type":"string","description":"Status of the search. Available values are new, approved, declined, pending, cancelled, referred and closed."},"riskRating":{"type":"string","description":"Risk associated with the search. Available values are notApplicable, veryLow, low, medium, high AND veryHigh."},"assignedToUserId":{"type":"integer","description":"Id of the user assigned to the search","format":"int32"},"assignedUser":{"type":"string","description":"Name of the user assigned to the search"},"createdById":{"type":"integer","description":"Id of the user who created the search","format":"int32"},"createdBy":{"type":"string","description":"Name of the user who created the search"},"createdAt":{"type":"string","description":"Search created date time","format":"date-time"},"modifiedById":{"type":"integer","description":"Id of the user who modified the search","format":"int32"},"modifiedBy":{"type":"string","description":"Name of the user who modified the search"},"modifiedAt":{"type":"string","description":"Search modified date time","format":"date-time"},"note":{"type":"string","description":"Note associated with the search"},"scheduleId":{"type":"string","description":"Schedule Id linked to the search","format":"uuid"},"totalHitCount":{"type":"integer","description":"Total number of hits in the search","format":"int32"},"truePositiveHitsCount":{"type":"integer","description":"The number of true-positive hits in the search","format":"int32"},"falsePositiveHitsCount":{"type":"integer","description":"The number of false-positive hits in the search","format":"int32"},"undecidedHitsCount":{"type":"integer","description":"The number of undecided hits in the search","format":"int32"},"correlationId":{"type":"string","description":"A unique ID assigned to this request."}}}},"components/schemas/KYCGetSearchBusinessesBySearchIdResponse":{"id":"components/schemas/KYCGetSearchBusinessesBySearchIdResponse","kind":"json-schema","title":"KYCGetSearchBusinessesBySearchIdResponse","data":{"type":"object","properties":{"id":{"type":"string","description":"Id of the search","format":"uuid"},"name":{"type":"string","description":"Name provided for the search. Length must not exceed 200 characters"},"countryCodes":{"type":"array","items":{"type":"string"},"description":"Countries provided to the search"},"threshold":{"type":"integer","description":"Hits with scores below this value will not be shown.","format":"int32"},"type":{"type":"string","description":"Indicates whether search type is individual or business"},"datasets":{"type":"array","items":{"type":"string"},"description":"Provided datasets for the search"},"sanctionBodies":{"type":["array","null"],"items":{"type":"integer"},"description":"Provided sanctionBodies for the search"},"status":{"type":"string","description":"Status of the search. Available values are new, approved, declined, pending, cancelled, referred and closed."},"riskRating":{"type":"string","description":"The risk rating being assigned to the profile","enum":["notApplicable","veryLow","low","medium","high","veryHigh"]},"assignedToUserId":{"type":"integer","description":"Id of the user assigned to the search","format":"int32"},"assignedUser":{"type":"string","description":"Name of the user assigned to the search"},"createdById":{"type":"integer","description":"Id of the user who created the search","format":"int32"},"createdBy":{"type":"string","description":"Name of the user who created the search"},"createdAt":{"type":"string","description":"Search created date time","format":"date-time"},"modifiedById":{"type":"integer","description":"Id of the user who modified the search","format":"int32"},"modifiedBy":{"type":"string","description":"Name of the user who modified the search"},"modifiedAt":{"type":"string","description":"Search modified date time","format":"date-time"},"note":{"type":"string","description":"Note associated with the search"},"scheduleId":{"type":"string","description":"Schedule Id linked to the search","format":"uuid"},"totalHitCount":{"type":"integer","description":"Total number of hits in the search","format":"int32"},"truePositiveHitsCount":{"type":"integer","description":"The number of true-positive hits in the search","format":"int32"},"falsePositiveHitsCount":{"type":"integer","description":"The number of false-positive hits in the search","format":"int32"},"undecidedHitsCount":{"type":"integer","description":"The number of undecided hits in the search","format":"int32"}}}},"components/schemas/KYCPutSearchBusinessesBySearchIdResponse":{"id":"components/schemas/KYCPutSearchBusinessesBySearchIdResponse","kind":"json-schema","title":"KYCPutSearchBusinessesBySearchIdResponse","data":{"type":"object","properties":{"id":{"type":"string","description":"Id of the search","format":"uuid"},"name":{"type":"string","description":"Name provided for the search. Length must not exceed 200 characters"},"countryCodes":{"type":"array","items":{"type":"string"},"description":"Countries provided to the search"},"threshold":{"type":"integer","description":"Hits with scores below this value will not be shown.","format":"int32"},"type":{"type":"string","description":"Indicates whether search type is individual or business"},"datasets":{"type":"array","items":{"type":"string"},"description":"Provided datasets for the search"},"status":{"type":"string","description":"Status of the search. Available values are new, approved, declined, pending, cancelled, referred and closed."},"riskRating":{"type":"string","description":"The risk rating being assigned to the profile","enum":["notApplicable","veryLow","low","medium","high","veryHigh"]},"assignedToUserId":{"type":"integer","description":"Id of the user assigned to the search","format":"int32"},"assignedUser":{"type":"string","description":"Name of the user assigned to the search"},"createdById":{"type":"integer","description":"Id of the user who created the search","format":"int32"},"createdBy":{"type":"string","description":"Name of the user who created the search"},"createdAt":{"type":"string","description":"Search created date time","format":"date-time"},"modifiedById":{"type":"integer","description":"Id of the user who modified the search","format":"int32"},"modifiedBy":{"type":"string","description":"Name of the user who modified the search"},"modifiedAt":{"type":"string","description":"Search modified date time","format":"date-time"},"note":{"type":"string","description":"Note associated with the search"},"scheduleId":{"type":"string","description":"Schedule Id linked to the search","format":"uuid"},"totalHitCount":{"type":"integer","description":"Total number of hits in the search","format":"int32"},"truePositiveHitsCount":{"type":"integer","description":"The number of true-positive hits in the search","format":"int32"},"falsePositiveHitsCount":{"type":"integer","description":"The number of false-positive hits in the search","format":"int32"},"undecidedHitsCount":{"type":"integer","description":"The number of undecided hits in the search","format":"int32"}}}},"components/schemas/KYCGetSearchBusinessesDownloadBySearchIdResponse":{"id":"components/schemas/KYCGetSearchBusinessesDownloadBySearchIdResponse","kind":"json-schema","title":"KYCGetSearchBusinessesDownloadBySearchIdResponse","data":{"type":"object","properties":{"searchId":{"type":"string","description":"Id of the search","format":"uuid"},"downloadUrl":{"type":"string","description":"Url of the file to download"},"fileName":{"type":"string","description":"Name of the file"},"expiresAt":{"type":"string","description":"Date and time when the url will expire","format":"date-time"}}}},"components/schemas/KYCGetSearchBusinessesBySearchIdHitsResponse":{"id":"components/schemas/KYCGetSearchBusinessesBySearchIdHitsResponse","kind":"json-schema","title":"KYCGetSearchBusinessesBySearchIdHitsResponse","data":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The Id of the search hit.","format":"uuid"},"hitScore":{"type":"integer","description":"The hit score associated to the search hit.","format":"int32"},"name":{"type":["string","null"],"description":"The name associated to the search hit."},"match":{"type":"string","description":"The match string associated to the search hit."},"countries":{"type":"array","items":{"type":"string"},"description":"The countries associated to the search hit."},"datasets":{"type":"array","items":{"type":"string"},"description":"The datasets associated to the search hit."},"decision":{"type":"string","description":"The decision made on the search hit. Available values are undecided, trueMatch, falsePositive and discarded."},"note":{"type":"string","description":"The note added to the search hit."},"modifiedById":{"type":"integer","description":"The search hit last modified by user id.","format":"int32"},"modifiedBy":{"type":"string","description":"The search hit last modified by user name."},"modifiedAt":{"type":"string","description":"The search hit last modified date and time.","format":"date-time"},"createdAt":{"type":"string","description":"The search hit created date and time.","format":"date-time"},"supersededHit":{"type":"object","properties":{"id":{"type":"string","description":"The Id of the search hit.","format":"uuid"},"hitScore":{"type":"integer","description":"The hit score associated to the search hit.","format":"int32"},"name":{"type":"string","description":"The name associated to the search hit."},"match":{"type":"string","description":"The match string associated to the search hit."},"countries":{"type":"array","items":{"type":"string"},"description":"The countries associated to the search hit."},"datasets":{"type":"array","items":{"type":"string"},"description":"The datasets associated to the search hit."},"decision":{"type":"string","description":"The decision made on the search hit. Available values are undecided, trueMatch, falsePositive anddiscarded."},"note":{"type":"string","description":"The note added to the search hit."},"modifiedById":{"type":"integer","description":"The search hit last modified by user id.","format":"int32"},"modifiedBy":{"type":"string","description":"The search hit last modified by user name."},"modifiedAt":{"type":"string","description":"The search hit last modified date and time.","format":"date-time"},"createdAt":{"type":"string","description":"The search hit created date and time.","format":"date-time"}}}}}},"totalSize":{"type":"number"}}}},"components/schemas/MODEL7b2457":{"id":"components/schemas/MODEL7b2457","kind":"json-schema","title":"MODEL7b2457","data":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","required":["hitId"],"properties":{"decision":{"type":"string","description":"The Decision of the Hit to be updated Decision can only be made once. Available values are undecided, truematch, falsepositive, discarded"},"note":{"type":"string","description":"Note associated with the Hit"},"hitId":{"type":"string","description":"The Id of the Hit to be updated"}}}}}}},"components/schemas/KYCPutSearchBusinessesBySearchIdHitsResponse":{"id":"components/schemas/KYCPutSearchBusinessesBySearchIdHitsResponse","kind":"json-schema","title":"KYCPutSearchBusinessesBySearchIdHitsResponse","data":{"type":"object","properties":{"failed":{"type":"array","items":{"type":"object","properties":{"failedItem":{"type":"object","properties":{"decision":{"type":"string","description":"The Decision of the Hit to be updated Decision can only be made once. Available values are undecided, truematch, falsepositive, discarded"},"note":{"type":"string","description":"Note associated with the Hit"},"hitId":{"type":"string","description":"The Id of the Hit to be updated"}}},"error":{"type":"object","properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"integer"},"detail":{"type":"string"},"instance":{"type":"string"}}}}}},"successful":{"type":"array","items":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The Id of the search hit.","format":"uuid"},"hitScore":{"type":"integer","description":"The hit score associated to the search hit.","format":"int32"},"name":{"type":"string","description":"The name associated to the search hit."},"match":{"type":"string","description":"The match string associated to the search hit."},"countries":{"type":"array","description":"The countries associated to the search hit.","items":{"type":"string"}},"datasets":{"type":"array","description":"The datasets associated to the search hit.","items":{"type":"string"}},"decision":{"type":"string","description":"The decision made on the search hit. Available values are undecided, trueMatch, falsePositive anddiscarded."},"note":{"type":"string","description":"The note added to the search hit."},"modifiedById":{"type":"integer","description":"The search hit last modified by user id.","format":"int32"},"modifiedBy":{"type":"string","description":"The search hit last modified by user name."},"modifiedAt":{"type":"string","description":"The search hit last modified date and time.","format":"date-time"},"createdAt":{"type":"string","description":"The search hit created date and time.","format":"date-time"},"supersededHit":{"type":"object","properties":{"id":{"type":"string","description":"The Id of the search hit.","format":"uuid"},"hitScore":{"type":"integer","description":"The hit score associated to the search hit.","format":"int32"},"name":{"type":"string","description":"The name associated to the search hit."},"match":{"type":"string","description":"The match string associated to the search hit."},"countries":{"type":"array","description":"The countries associated to the search hit.","items":{"type":"string"}},"datasets":{"type":"array","description":"The datasets associated to the search hit.","items":{"type":"string"}},"decision":{"type":"string","description":"The decision made on the search hit. Available values are undecided, trueMatch, falsePositive and discarded."},"note":{"type":"string","description":"The note added to the search hit."},"modifiedById":{"type":"integer","description":"The search hit last modified by user id.","format":"int32"},"modifiedBy":{"type":"string","description":"The search hit last modified by user name."},"modifiedAt":{"type":"string","description":"The search hit last modified date and time.","format":"date-time"},"createdAt":{"type":"string","description":"The search hit created date and time.","format":"date-time"}}}}}}}}}}}},"components/schemas/WebApiModelsSearchesSearchResultHitsHitIdentifierResponse":{"id":"components/schemas/WebApiModelsSearchesSearchResultHitsHitIdentifierResponse","kind":"json-schema","title":"WebApiModelsSearchesSearchResultHitsHitIdentifierResponse","data":{"type":"object","properties":{"type":{"type":"string","description":"The type of the hit identifier"},"value":{"type":"string","description":"The value of the hit identifier"}}}},"components/schemas/WebApiModelsSearchesSearchResultHitsHitAddressResponse":{"id":"components/schemas/WebApiModelsSearchesSearchResultHitsHitAddressResponse","kind":"json-schema","title":"WebApiModelsSearchesSearchResultHitsHitAddressResponse","data":{"type":"object","properties":{"postalCode":{"type":["string","null"],"description":"The postal code of the address"},"line1":{"type":["string","null"],"description":"The line1 of the address"},"line2":{"type":["string","null"],"description":"The line2 of the address"},"type":{"type":["string","null"],"description":"The type of the address"},"county":{"type":["string","null"],"description":"The county of the address"},"countryCode":{"type":["string","null"],"description":"The country code of the address"},"city":{"type":["string","null"],"description":"The city of the address"}}}},"components/schemas/WebApiModelsSearchesSearchResultHitsHitContactResponse":{"id":"components/schemas/WebApiModelsSearchesSearchResultHitsHitContactResponse","kind":"json-schema","title":"WebApiModelsSearchesSearchResultHitsHitContactResponse","data":{"type":"object","properties":{"type":{"type":"string","description":"Avaialable values are telephone, fax, mobile, email, website"},"value":{"type":"string"}}}},"components/schemas/WebApiModelsSearchesSearchResultHitsHitIndividualLinkResponse":{"id":"components/schemas/WebApiModelsSearchesSearchResultHitsHitIndividualLinkResponse","kind":"json-schema","title":"WebApiModelsSearchesSearchResultHitsHitIndividualLinkResponse","data":{"type":"object","properties":{"relationship":{"type":"string","description":"The relationship of the associated link"},"ownershipPercentage":{"type":["integer","null"],"description":"The ownership percentage of the associated link","format":"int32"},"datasets":{"type":"array","items":{"type":"string"},"description":"The datasets associated with the link"},"firstName":{"type":["string","null"],"description":"The first name of the individual link"},"middleName":{"type":["string","null"],"description":"The middle name of the individual link"},"lastName":{"type":["string","null"],"description":"The last name of the individual link"}}}},"components/schemas/WebApiModelsSearchesSearchResultHitsHitBusinessLinkResponse":{"id":"components/schemas/WebApiModelsSearchesSearchResultHitsHitBusinessLinkResponse","kind":"json-schema","title":"WebApiModelsSearchesSearchResultHitsHitBusinessLinkResponse","data":{"type":"object","properties":{"relationship":{"type":"string","description":"The relationship of the associated link"},"ownershipPercentage":{"type":["integer","null"],"description":"The ownership percentage of the associated link","format":"int32"},"datasets":{"type":"array","items":{"type":"string"},"description":"The datasets associated with the link"},"name":{"type":"string","description":"The name of the link"},"individualLinks":{"type":"array","items":{"$ref":"#/components/schemas/WebApiModelsSearchesSearchResultHitsHitIndividualLinkResponse"},"description":"The individual links associated to the business link"}}}},"components/schemas/WebApiModelsSearchesSearchResultHitsHitSourceResponse":{"id":"components/schemas/WebApiModelsSearchesSearchResultHitsHitSourceResponse","kind":"json-schema","title":"WebApiModelsSearchesSearchResultHitsHitSourceResponse","data":{"type":"object","properties":{"title":{"type":["string","null"],"description":"The title of the hit source"},"description":{"type":["string","null"],"description":"The description of the hit source"},"link":{"type":"string","description":"The URL associated to the hit source"},"dateAdded":{"type":["string","null"],"description":"The date when the hit source is added","format":"date"},"isCopyrighted":{"type":["boolean","null"],"description":"Represents whether hit source is copyrighted"},"datePublished":{"type":["string","null"],"description":"The date when hit source is published","format":"date"},"documentLink":{"type":["string","null"],"description":"The document link associated to the hit source"},"datasets":{"type":["array","null"],"items":{"type":"string"},"description":"The datasets associated with the hit source"}}}},"components/schemas/WebApiModelsSearchesSearchResultHitsHitBusinessAliasResponse":{"id":"components/schemas/WebApiModelsSearchesSearchResultHitsHitBusinessAliasResponse","kind":"json-schema","title":"WebApiModelsSearchesSearchResultHitsHitBusinessAliasResponse","data":{"type":"object","properties":{"type":{"type":["string","null"]},"name":{"type":["string","null"]}}}},"components/schemas/WebApiModelsSearchesSearchResultHitsEntriesEventsHitEventResponse":{"id":"components/schemas/WebApiModelsSearchesSearchResultHitsEntriesEventsHitEventResponse","kind":"json-schema","title":"WebApiModelsSearchesSearchResultHitsEntriesEventsHitEventResponse","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"type":{"type":"string"},"date":{"type":["string","null"],"description":"Can be in the format YYYY or YYYY-MM-DD","format":"date"},"amount":{"type":["integer","null"],"format":"int32"},"currencyCode":{"type":["string","null"]},"duration":{"type":["string","null"]},"sources":{"type":"array","items":{"$ref":"#/components/schemas/WebApiModelsSearchesSearchResultHitsHitSourceResponse"}}}}},"components/schemas/WebApiModelsSearchesSearchResultHitsEntriesAdverseMediaEntryValueResponse":{"id":"components/schemas/WebApiModelsSearchesSearchResultHitsEntriesAdverseMediaEntryValueResponse","kind":"json-schema","title":"WebApiModelsSearchesSearchResultHitsEntriesAdverseMediaEntryValueResponse","data":{"type":"object","properties":{"category":{"type":"string"},"subCategory":{"type":"string"}}}},"components/schemas/WebApiModelsSearchesSearchResultHitsEntriesAdverseMediaEntryResponse":{"id":"components/schemas/WebApiModelsSearchesSearchResultHitsEntriesAdverseMediaEntryResponse","kind":"json-schema","title":"WebApiModelsSearchesSearchResultHitsEntriesAdverseMediaEntryResponse","data":{"type":"object","properties":{"events":{"type":["array","null"],"items":{"$ref":"#/components/schemas/WebApiModelsSearchesSearchResultHitsEntriesEventsHitEventResponse"}},"sources":{"type":["array","null"],"items":{"$ref":"#/components/schemas/WebApiModelsSearchesSearchResultHitsHitSourceResponse"}},"type":{"type":"string","description":"Avaialable values are adverseMedia, disqualifiedDirector, insolvencyRegister, pep, pepLinked, profileOfInterest, enforcement, sanction, stateOwnedEnterprise"},"value":{"$ref":"#/components/schemas/WebApiModelsSearchesSearchResultHitsEntriesAdverseMediaEntryValueResponse"}}}},"components/schemas/WebApiModelsSearchesSearchResultHitsEntriesEnforcementEntryValueResponse":{"id":"components/schemas/WebApiModelsSearchesSearchResultHitsEntriesEnforcementEntryValueResponse","kind":"json-schema","title":"WebApiModelsSearchesSearchResultHitsEntriesEnforcementEntryValueResponse","data":{"type":"object","properties":{"category":{"type":"string"},"subCategory":{"type":"string"}}}},"components/schemas/WebApiModelsSearchesSearchResultHitsEntriesEnforcementEntryResponse":{"id":"components/schemas/WebApiModelsSearchesSearchResultHitsEntriesEnforcementEntryResponse","kind":"json-schema","title":"WebApiModelsSearchesSearchResultHitsEntriesEnforcementEntryResponse","data":{"type":"object","properties":{"events":{"type":["array","null"],"items":{"$ref":"#/components/schemas/WebApiModelsSearchesSearchResultHitsEntriesEventsHitEventResponse"}},"sources":{"type":["array","null"],"items":{"$ref":"#/components/schemas/WebApiModelsSearchesSearchResultHitsHitSourceResponse"}},"type":{"type":"string","description":"Avaialable values are adverseMedia, disqualifiedDirector, insolvencyRegister, pep, pepLinked, profileOfInterest, enforcement, sanction, stateOwnedEnterprise"},"value":{"$ref":"#/components/schemas/WebApiModelsSearchesSearchResultHitsEntriesEnforcementEntryValueResponse"}}}},"components/schemas/WebApiModelsSearchesSearchResultHitsEntriesCourtResponse":{"id":"components/schemas/WebApiModelsSearchesSearchResultHitsEntriesCourtResponse","kind":"json-schema","title":"WebApiModelsSearchesSearchResultHitsEntriesCourtResponse","data":{"type":"object","properties":{"name":{"type":"string"},"petitioner":{"type":"string"},"hearingDate":{"type":["string","null"],"format":"date-time"},"petitionPresentedDate":{"type":["string","null"],"format":"date-time"}}}},"components/schemas/WebApiModelsSearchesSearchResultHitsEntriesInsolvencyEntryValueResponse":{"id":"components/schemas/WebApiModelsSearchesSearchResultHitsEntriesInsolvencyEntryValueResponse","kind":"json-schema","title":"WebApiModelsSearchesSearchResultHitsEntriesInsolvencyEntryValueResponse","data":{"type":"object","properties":{"insolvencyIdNumber":{"type":"string"},"type":{"type":"string"},"debtAmount":{"type":"string"},"startDate":{"type":["string","null"],"format":"date-time"},"endDate":{"type":["string","null"],"format":"date-time"},"caseReferenceNumbers":{"type":"array","items":{"type":"string"}},"solicitor":{"type":"string"},"court":{"$ref":"#/components/schemas/WebApiModelsSearchesSearchResultHitsEntriesCourtResponse"},"orderDate":{"type":["string","null"],"format":"date-time"},"gazetteIssuedDate":{"type":["string","null"],"format":"date-time"},"awardDate":{"type":["string","null"],"format":"date-time"}}}},"components/schemas/WebApiModelsSearchesSearchResultHitsEntriesInsolvencyEntryResponse":{"id":"components/schemas/WebApiModelsSearchesSearchResultHitsEntriesInsolvencyEntryResponse","kind":"json-schema","title":"WebApiModelsSearchesSearchResultHitsEntriesInsolvencyEntryResponse","data":{"type":"object","properties":{"events":{"type":["array","null"],"items":{"$ref":"#/components/schemas/WebApiModelsSearchesSearchResultHitsEntriesEventsHitEventResponse"}},"sources":{"type":["array","null"],"items":{"$ref":"#/components/schemas/WebApiModelsSearchesSearchResultHitsHitSourceResponse"}},"type":{"type":"string","description":"Avaialable values are adverseMedia, disqualifiedDirector, insolvencyRegister, pep, pepLinked, profileOfInterest, enforcement, sanction, stateOwnedEnterprise"},"value":{"$ref":"#/components/schemas/WebApiModelsSearchesSearchResultHitsEntriesInsolvencyEntryValueResponse"}}}},"components/schemas/WebApiModelsSearchesSearchResultHitsEntriesPositionResponse":{"id":"components/schemas/WebApiModelsSearchesSearchResultHitsEntriesPositionResponse","kind":"json-schema","title":"WebApiModelsSearchesSearchResultHitsEntriesPositionResponse","data":{"type":"object","properties":{"name":{"type":"string"},"segment":{"type":"string"},"country":{"type":"string"},"fromDate":{"type":["string","null"],"description":"Can be in the format YYYY or YYYY-MM-DD","format":"date"},"toDate":{"type":["string","null"],"description":"Can be in the format YYYY or YYYY-MM-DD","format":"date"}}}},"components/schemas/WebApiModelsSearchesSearchResultHitsEntriesProfileOfInterestEntryValueResponse":{"id":"components/schemas/WebApiModelsSearchesSearchResultHitsEntriesProfileOfInterestEntryValueResponse","kind":"json-schema","title":"WebApiModelsSearchesSearchResultHitsEntriesProfileOfInterestEntryValueResponse","data":{"type":"object","properties":{"category":{"type":"string"},"positions":{"type":"array","items":{"$ref":"#/components/schemas/WebApiModelsSearchesSearchResultHitsEntriesPositionResponse"}}},"additionalProperties":false}},"components/schemas/WebApiModelsSearchesSearchResultHitsEntriesProfileOfInterestEntryResponse":{"id":"components/schemas/WebApiModelsSearchesSearchResultHitsEntriesProfileOfInterestEntryResponse","kind":"json-schema","title":"WebApiModelsSearchesSearchResultHitsEntriesProfileOfInterestEntryResponse","data":{"type":"object","properties":{"events":{"type":["array","null"],"items":{"$ref":"#/components/schemas/WebApiModelsSearchesSearchResultHitsEntriesEventsHitEventResponse"}},"sources":{"type":["array","null"],"items":{"$ref":"#/components/schemas/WebApiModelsSearchesSearchResultHitsHitSourceResponse"}},"type":{"type":"string","description":"Avaialable values are adverseMedia, disqualifiedDirector, insolvencyRegister, pep, pepLinked, profileOfInterest, enforcement, sanction, stateOwnedEnterprise"},"value":{"$ref":"#/components/schemas/WebApiModelsSearchesSearchResultHitsEntriesProfileOfInterestEntryValueResponse"}}}},"components/schemas/WebApiModelsSearchesSearchResultHitsEntriesSanctionEntryValueResponse":{"id":"components/schemas/WebApiModelsSearchesSearchResultHitsEntriesSanctionEntryValueResponse","kind":"json-schema","title":"WebApiModelsSearchesSearchResultHitsEntriesSanctionEntryValueResponse","data":{"type":"object","properties":{"sanctionId":{"type":["string","null"]},"issuingBody":{"type":["string","null"]},"origin":{"type":["string","null"]},"sanctionTypes":{"type":["string","null"],"items":{"type":"string"}},"measures":{"type":["array","null"],"items":{"type":"string"}},"regime":{"type":["string","null"]}}}},"components/schemas/WebApiModelsSearchesSearchResultHitsEntriesSanctionEntryResponse":{"id":"components/schemas/WebApiModelsSearchesSearchResultHitsEntriesSanctionEntryResponse","kind":"json-schema","title":"WebApiModelsSearchesSearchResultHitsEntriesSanctionEntryResponse","data":{"type":"object","properties":{"events":{"type":["array","null"],"items":{"$ref":"#/components/schemas/WebApiModelsSearchesSearchResultHitsEntriesEventsHitEventResponse"}},"sources":{"type":["array","null"],"items":{"$ref":"#/components/schemas/WebApiModelsSearchesSearchResultHitsHitSourceResponse"}},"type":{"type":"string","description":"Avaialable values are adverseMedia, disqualifiedDirector, insolvencyRegister, pep, pepLinked, profileOfInterest, enforcement, sanction, stateOwnedEnterprise"},"value":{"$ref":"#/components/schemas/WebApiModelsSearchesSearchResultHitsEntriesSanctionEntryValueResponse"}}}},"components/schemas/WebApiModelsSearchesSearchResultHitsHitAmlResultsSanctionsResponse":{"id":"components/schemas/WebApiModelsSearchesSearchResultHitsHitAmlResultsSanctionsResponse","kind":"json-schema","title":"WebApiModelsSearchesSearchResultHitsHitAmlResultsSanctionsResponse","data":{"type":"object","properties":{"CURRENT":{"type":"array","items":{"$ref":"#/components/schemas/WebApiModelsSearchesSearchResultHitsEntriesSanctionEntryResponse"}},"FORMER":{"type":"array","items":{"$ref":"#/components/schemas/WebApiModelsSearchesSearchResultHitsEntriesSanctionEntryResponse"}}}}},"components/schemas/WebApiModelsSearchesSearchResultHitsEntriesStateOwnedEnterpriseEntryValueResponse":{"id":"components/schemas/WebApiModelsSearchesSearchResultHitsEntriesStateOwnedEnterpriseEntryValueResponse","kind":"json-schema","title":"WebApiModelsSearchesSearchResultHitsEntriesStateOwnedEnterpriseEntryValueResponse","data":{"type":"object","properties":{"type":{"type":"string","description":"Avaialable values are current, former"},"level":{"type":"string"}}}},"components/schemas/WebApiModelsSearchesSearchResultHitsEntriesStateOwnedEnterpriseEntryResponse":{"id":"components/schemas/WebApiModelsSearchesSearchResultHitsEntriesStateOwnedEnterpriseEntryResponse","kind":"json-schema","title":"WebApiModelsSearchesSearchResultHitsEntriesStateOwnedEnterpriseEntryResponse","data":{"type":"object","properties":{"events":{"type":["array","null"],"items":{"$ref":"#/components/schemas/WebApiModelsSearchesSearchResultHitsEntriesEventsHitEventResponse"}},"sources":{"type":["array","null"],"items":{"$ref":"#/components/schemas/WebApiModelsSearchesSearchResultHitsHitSourceResponse"}},"type":{"type":"string","description":"Avaialable values are adverseMedia, disqualifiedDirector, insolvencyRegister, pep, pepLinked, profileOfInterest, enforcement, sanction, stateOwnedEnterprise"},"value":{"$ref":"#/components/schemas/WebApiModelsSearchesSearchResultHitsEntriesStateOwnedEnterpriseEntryValueResponse"}}}},"components/schemas/WebApiModelsSearchesSearchResultHitsBusinessHitAmlResultsResponse":{"id":"components/schemas/WebApiModelsSearchesSearchResultHitsBusinessHitAmlResultsResponse","kind":"json-schema","title":"WebApiModelsSearchesSearchResultHitsBusinessHitAmlResultsResponse","data":{"type":"object","properties":{"AM":{"type":"array","items":{"$ref":"#/components/schemas/WebApiModelsSearchesSearchResultHitsEntriesAdverseMediaEntryResponse"}},"ENF":{"type":"array","items":{"$ref":"#/components/schemas/WebApiModelsSearchesSearchResultHitsEntriesEnforcementEntryResponse"}},"INS":{"type":"array","items":{"$ref":"#/components/schemas/WebApiModelsSearchesSearchResultHitsEntriesInsolvencyEntryResponse"}},"POI":{"type":"array","items":{"$ref":"#/components/schemas/WebApiModelsSearchesSearchResultHitsEntriesProfileOfInterestEntryResponse"}},"SAN":{"$ref":"#/components/schemas/WebApiModelsSearchesSearchResultHitsHitAmlResultsSanctionsResponse"},"SOE":{"$ref":"#/components/schemas/WebApiModelsSearchesSearchResultHitsEntriesStateOwnedEnterpriseEntryResponse"}}}},"components/schemas/WebApiModelsSearchesSearchResultHitsBusinessSearchResultHitResponse":{"id":"components/schemas/WebApiModelsSearchesSearchResultHitsBusinessSearchResultHitResponse","kind":"json-schema","title":"WebApiModelsSearchesSearchResultHitsBusinessSearchResultHitResponse","data":{"type":"object","properties":{"id":{"type":"string","description":"The Id of the search hit","format":"uuid"},"hitScore":{"type":"integer","description":"The hit score associated to the search hit","format":"int32"},"name":{"type":["string","null"],"description":"The name associated to the search hit"},"match":{"type":["string","null"],"description":"The match string associated to the search hit"},"note":{"type":["string","null"],"description":"The note added to the search hit"},"countries":{"type":["array","null"],"items":{"type":"string"},"description":"The countries associated to the search hit"},"datasets":{"type":"array","items":{"type":"string"},"description":"The datasets associated to the search hit"},"profileImages":{"type":["array","null"],"items":{"type":"string"},"description":"The profile images associated to the search hit"},"screeningNotes":{"type":["array","null"],"items":{"type":"string"},"description":"The screening notes associated to the search hit"},"modifiedAt":{"type":"string","description":"The search hit modified date and time","format":"date-time"},"modifiedById":{"type":"integer","description":"The search hit modified by user id","format":"int32"},"modifiedBy":{"type":"string","description":"The search hit modified by user name"},"createdAt":{"type":"string","description":"The search hit created date and time","format":"date-time"},"decision":{"type":"string","description":"The decision made on the search hit Avaialable values are undecided, trueMatch, falsePositive, discarded"},"identifiers":{"type":"array","items":{"$ref":"#/components/schemas/WebApiModelsSearchesSearchResultHitsHitIdentifierResponse"},"description":"The identifiers associated to the search hit"},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/WebApiModelsSearchesSearchResultHitsHitAddressResponse"},"description":"The addresses associated to the search hit"},"contacts":{"type":"array","items":{"$ref":"#/components/schemas/WebApiModelsSearchesSearchResultHitsHitContactResponse"},"description":"The contact details associated to the search hit"},"businessLinks":{"type":"array","items":{"$ref":"#/components/schemas/WebApiModelsSearchesSearchResultHitsHitBusinessLinkResponse"},"description":"The business links associated to the search hit"},"individualLinks":{"type":"array","items":{"$ref":"#/components/schemas/WebApiModelsSearchesSearchResultHitsHitIndividualLinkResponse"},"description":"The individual links associated to the search hit"},"sources":{"type":"array","items":{"$ref":"#/components/schemas/WebApiModelsSearchesSearchResultHitsHitSourceResponse"},"description":"The sources associated to the search hit"},"activities":{"type":["array","null"],"items":{"type":"string"},"description":"The activities associated to the search hit"},"aliases":{"type":"array","items":{"$ref":"#/components/schemas/WebApiModelsSearchesSearchResultHitsHitBusinessAliasResponse"},"description":"The aliases associated to the search hit"},"amlResults":{"$ref":"#/components/schemas/WebApiModelsSearchesSearchResultHitsBusinessHitAmlResultsResponse"},"description":{"type":["string","null"],"description":"The description associated to the search hit"},"businessTypes":{"type":["array","null"],"items":{"type":"string"},"description":"The business types associated to the search hit"}}}},"components/schemas/KYCBaseBusinessSearchResultHitSummaryResponse":{"id":"components/schemas/KYCBaseBusinessSearchResultHitSummaryResponse","kind":"json-schema","title":"KYCBaseBusinessSearchResultHitSummaryResponse","data":{"type":"object","properties":{"id":{"type":"string","description":"The Id of the search hit.","format":"uuid"},"hitScore":{"type":"integer","description":"The hit score associated to the search hit.","format":"int32"},"name":{"type":["string","null"],"description":"The name associated to the search hit."},"match":{"type":["string","null"],"description":"The match string associated to the search hit."},"countries":{"type":["array","null"],"items":{"type":"string"},"description":"The countries associated to the search hit."},"datasets":{"type":"array","items":{"type":"string"},"description":"The datasets associated to the search hit."},"decision":{"type":"string","description":"The decision made on the search hit. Available values are undecided, trueMatch, falsePositive, discarded."},"note":{"type":["string","null"],"description":"The note added to the search hit."},"modifiedById":{"type":"integer","description":"The search hit last modified by user id.","format":"int32"},"modifiedBy":{"type":["string","null"],"description":"The search hit last modified by user name."},"modifiedAt":{"type":"string","description":"The search hit last modified date and time.","format":"date-time"},"createdAt":{"type":"string","description":"The search hit created date and time.","format":"date-time"}}}},"components/schemas/KYCBusinessSearchResultHitSummaryResponse":{"id":"components/schemas/KYCBusinessSearchResultHitSummaryResponse","kind":"json-schema","title":"KYCBusinessSearchResultHitSummaryResponse","data":{"type":"object","properties":{"id":{"type":"string","description":"The Id of the search hit.","format":"uuid"},"hitScore":{"type":"integer","description":"The hit score associated to the search hit.","format":"int32"},"name":{"type":["string","null"],"description":"The name associated to the search hit."},"match":{"type":["string","null"],"description":"The match string associated to the search hit."},"countries":{"type":["array","null"],"items":{"type":"string"},"description":"The countries associated to the search hit."},"datasets":{"type":"array","items":{"type":"string"},"description":"The datasets associated to the search hit."},"decision":{"type":"string","description":"The decision made on the search hit. Available values are undecided, trueMatch, falsePositive, discarded."},"note":{"type":["string","null"],"description":"The note added to the search hit."},"modifiedById":{"type":"integer","description":"The search hit last modified by user id.","format":"int32"},"modifiedBy":{"type":["string","null"],"description":"The search hit last modified by user name."},"modifiedAt":{"type":"string","description":"The search hit last modified date and time.","format":"date-time"},"createdAt":{"type":"string","description":"The search hit created date and time.","format":"date-time"},"supersededHit":{"$ref":"#/components/schemas/KYCBaseBusinessSearchResultHitSummaryResponse"}}}},"components/schemas/WebApiModelsSearchesSearchResultHitsBusinessSearchHitAttachmentLinkResponse":{"id":"components/schemas/WebApiModelsSearchesSearchResultHitsBusinessSearchHitAttachmentLinkResponse","kind":"json-schema","title":"WebApiModelsSearchesSearchResultHitsBusinessSearchHitAttachmentLinkResponse","data":{"type":"object","properties":{"downloadUrl":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The direct URL to download the PDF file containing AML details for the specified hit. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This URL is valid only until the expiration time specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expiresAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},"fileName":{"type":"string","description":"The name of the downloaded PDF file, generated automatically based on the search  and hit details.\n"},"expiresAt":{"type":"string","format":"date-time","description":"The expiration date and time for the download URL. After this time, the link will  no longer be valid.\n"},"searchId":{"type":"string","format":"uuid","description":"The unique identifier of the search that generated the hit, provided as a reference  for the requested file.\n"},"hitId":{"type":"string","format":"uuid","description":"The unique identifier of the hit associated with the search. This ID corresponds  to the flagged result being downloaded.\n"}}}},"components/schemas/WebApiModelsSearchesBusinessesSearchIdHitsHitIdSourcesSourceIdCopyrightedDownloadResponse":{"id":"components/schemas/WebApiModelsSearchesBusinessesSearchIdHitsHitIdSourcesSourceIdCopyrightedDownloadResponse","kind":"json-schema","title":"WebApiModelsSearchesBusinessesSearchIdHitsHitIdSourcesSourceIdCopyrightedDownloadResponse","data":{"type":"object","properties":{"downloadUrl":{"type":"string","description":"Url of the file to download"},"fileName":{"type":"string","description":"Name of the file"},"expiresAt":{"type":"string","description":"Date and time when the url will expire","format":"date-time"},"searchId":{"type":"string","description":"Id of the search","format":"uuid"},"hitId":{"type":"string","description":"Id of the hit","format":"uuid"},"sourceId":{"type":"string","description":"Id of the hit","format":"uuid"}}}},"components/schemas/KycProtectIndividualSearchResponse":{"id":"components/schemas/KycProtectIndividualSearchResponse","kind":"json-schema","title":"KycProtectIndividualSearchResponse","data":{"type":"object","properties":{"totalSize":{"type":"integer","format":"int32"},"items":{"type":"array","items":{"$ref":"#/components/schemas/KycProtectGetIndividualSearchItems"}}}}},"components/schemas/PutKYCIndividualSearchRequest":{"id":"components/schemas/PutKYCIndividualSearchRequest","kind":"json-schema","title":"PutKYCIndividualSearchRequest","data":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","required":["searchId","riskRating"],"properties":{"assignedToUserId":{"type":"object","description":"Id of the User to assign to the Search","format":"int32"},"status":{"type":"object","description":"Status of the Search and allowed values are new,approved,declined,pending,cancelled,referred and closed"},"riskRating":{"type":"object","description":"Risk rating of the Search and allowed values notApplicable,veryLow,low,medium,high and veryHigh"},"note":{"type":"object","description":"Note associated with the search"},"searchId":{"type":"string","description":"The Id of the search to be updated","format":"uuid"}}}}}}},"components/schemas/KYCPUTSearchIndividualResponse":{"id":"components/schemas/KYCPUTSearchIndividualResponse","kind":"json-schema","title":"KYCPUTSearchIndividualResponse","data":{"type":"object","properties":{"failed":{"type":"array","items":{"type":"object","properties":{"failedItem":{"type":"object","properties":{"assignedToUserId":{"type":"integer","description":"Id of the User to assign to the Search","format":"int32"},"status":{"type":"string","description":"Status of the Search. Available values are new, approved, declined, pending, cancelled, referred and closed."},"riskRating":{"type":"string","description":"Risk rating of the Search. Available values are notApplicable, veryLow, low, medium, high AND veryHigh."},"note":{"type":"string","description":"Note associated with the search"},"searchId":{"type":"string","description":"The Id of the search to be updated","format":"uuid"}}},"error":{"type":"object","properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"integer"},"detail":{"type":"string"},"instance":{"type":"string"}}}}}},"successful":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Id of the search","format":"uuid"},"name":{"type":"string","description":"Name provided for the search. Length must not exceed 200 characters"},"countryCodes":{"type":"array","description":"Countries provided to the search","items":{"type":"string"}},"threshold":{"type":"integer","description":"Hits with scores below this value will not be shown.","format":"int32"},"type":{"type":"string","description":"Indicates whether search type is individual or business"},"datasets":{"type":"array","description":"Provided datasets for the search","items":{"type":"string"}},"status":{"type":"string","description":"Status of the search"},"riskRating":{"type":"string","description":"Risk associated with the search"},"assignedToUserId":{"type":"integer","description":"Id of the user assigned to the search","format":"int32"},"assignedUser":{"type":"string","description":"Name of the user assigned to the search"},"createdById":{"type":"integer","description":"Id of the user who created the search","format":"int32"},"createdBy":{"type":"string","description":"Name of the user who created the search"},"createdAt":{"type":"string","description":"Search created date time","format":"date-time"},"modifiedById":{"type":"integer","description":"Id of the user who modified the search","format":"int32"},"modifiedBy":{"type":"string","description":"Name of the user who modified the search"},"modifiedAt":{"type":"string","description":"Search modified date time","format":"date-time"},"note":{"type":"string","description":"Note associated with the search"},"totalHitCount":{"type":"integer","description":"Total number of hits in the search","format":"int32"},"truePositiveHitsCount":{"type":"integer","description":"The number of true-positive hits in the search","format":"int32"},"falsePositiveHitsCount":{"type":"integer","description":"The number of false-positive hits in the search","format":"int32"},"undecidedHitsCount":{"type":"integer","description":"The number of undecided hits in the search","format":"int32"},"firstName":{"type":"string","description":"First name provided in the search.\r\nThe combination of first name, middle name, and last name must not exceed 200 characters"},"middleName":{"type":"string","description":"Middle name provided in the search.\r\nThe combination of first name, middle name, and last name must not exceed 200 characters"},"lastName":{"type":"string","description":"Last name provided in the search.\r\nThe combination of first name, middle name, and last name must not exceed 200 characters"},"gender":{"type":"string","description":"Gender provided in the search"},"dateOfBirth":{"type":"string","description":"DOB provided in the search","format":"date"},"pepTiers":{"type":"array","description":"Pep Tiers provided in the search","items":{"type":"string"}},"isDobRequired":{"type":["boolean","null"],"description":"Indicates whether date of birth is required for the individual search.","default":true}}}},"correlationId":{"type":"string","description":"A unique ID assigned to this request."}}}},"components/schemas/KYCPostIndividualSearchContract":{"id":"components/schemas/KYCPostIndividualSearchContract","kind":"json-schema","title":"KYCPostIndividualSearchContract","data":{"type":"object","required":["threshold","datasets"],"properties":{"countryCodes":{"type":["array","null"],"items":{"type":"string"},"description":"List of Two-letter country code ISO-3166-2."},"threshold":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hits with scores below the chosen value will not be shown. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Must be one of 75, 80, 85, 90, 95, or 100"},"children":[]}]}]}],"format":"int32"},"sanctionBodies":{"type":["array","null"],"description":"Specifies which SanctionBodies will be searched. When null is supplied, the Settings preferences will be applied. When null is supplied and Settings preferences not set, all sanction bodies will be applied. When no sanction bodies supplied, all sanction bodies will be applied.","items":{"type":"integer"}},"name":{"type":["string","null"],"description":"Required if FirstName and LastName are not provided"},"firstName":{"type":["string","null"],"description":"If firstName is provided then lastName must also be provided"},"middleName":{"type":["string","null"],"description":"middleName is optional, valid along with firstName and lastName only"},"lastName":{"type":["string","null"],"description":"If LastName is provided then FirstName must also be provided"},"dateOfBirth":{"type":["string","null"],"description":"Date YYYY-MM-DD or YYYY format. Must be after 1900 and not in the future.","format":"date"},"gender":{"enum":["male","female"],"type":["string","null"],"description":"Define the gender of the individual you are searching for. Available values are male and female."},"pepTiers":{"type":["array","null"],"items":{"enum":["pepTier1","pepTier2","pepTier3"],"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When searching the PEP dataset, define what tiers of the PEP profiles should be included in the results."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" PEP Tier 1 - senior roles"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"  PEP Tier 2 - middle-ranking"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"  PEP Tier 3 - junior officials "},"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":" If the PEP Dataset is NOT included on the list of searched datasets, then this value is ignored. "},"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":"The PEP Tier filter does not apply to PEP-LINKED Profiles."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]}]},"datasets":{"type":["array","null"],"items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies which datasets will be searched "},"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":"PEP"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Politically Exposed Persons (All)"},"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":"PEP-CURRENT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Only current PEPs"},"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":"PEP-FORMER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Only former PEPs"},"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":"PEP-LINKED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Only linked PEPs (PEP by Association)"},"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":"SAN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Sanctioned (All)"},"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":"SAN-CURRENT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Only current Sanctions "},"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":"SAN-FORMER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Only former Sanctions"},"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":"INS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Insolvency "},"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":"AM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Averse Media "},"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":"POI"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Profile of Interest "},"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":"ENF"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Enforcement "},"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":"DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Disqualified Director"},"children":[]}]}]}]}}}},"components/schemas/KycProtectPostPostIndividualSearchResponse":{"id":"components/schemas/KycProtectPostPostIndividualSearchResponse","kind":"json-schema","title":"KycProtectPostPostIndividualSearchResponse","data":{"type":"object","properties":{"id":{"type":"string","description":"Id of the search","format":"uuid"},"name":{"type":["string","null"],"description":"Name provided for the search. Length must not exceed 200 characters"},"countryCodes":{"type":"array","items":{"type":["string","null"]},"description":"Countries provided to the search"},"threshold":{"type":"integer","description":"Hits with scores below this value will not be shown.","format":"int32"},"type":{"type":"string","description":"Indicates whether search type is individual or business"},"datasets":{"type":"array","items":{"type":"string"},"description":"Provided datasets for the search"},"status":{"type":"string","description":"Status of the search"},"riskRating":{"type":"string","description":"Risk associated with the search"},"assignedToUserId":{"type":["integer","null"],"description":"Id of the user assigned to the search","format":"int32"},"assignedUser":{"type":["string","null"],"description":"Name of the user assigned to the search"},"createdById":{"type":"integer","description":"Id of the user who created the search","format":"int32"},"createdBy":{"type":"string","description":"Name of the user who created the search"},"createdAt":{"type":"string","description":"Search created date time","format":"date-time"},"modifiedById":{"type":"integer","description":"Id of the user who modified the search","format":"int32"},"modifiedBy":{"type":"string","description":"Name of the user who modified the search"},"modifiedAt":{"type":"string","description":"Search modified date time","format":"date-time"},"note":{"type":["string","null"],"description":"Note associated with the search"},"totalHitCount":{"type":"integer","description":"Total number of hits in the search","format":"int32"},"truePositiveHitsCount":{"type":"integer","description":"The number of true-positive hits in the search","format":"int32"},"falsePositiveHitsCount":{"type":"integer","description":"The number of false-positive hits in the search","format":"int32"},"undecidedHitsCount":{"type":"integer","description":"The number of undecided hits in the search","format":"int32"},"firstName":{"type":["string","null"],"description":"First name provided in the search.\r\nThe combination of first name, middle name, and last name must not exceed 200 characters"},"middleName":{"type":["string","null"],"description":"Middle name provided in the search.\r\nThe combination of first name, middle name, and last name must not exceed 200 characters"},"lastName":{"type":["string","null"],"description":"Last name provided in the search.\r\nThe combination of first name, middle name, and last name must not exceed 200 characters"},"gender":{"type":["string","null"],"description":"Gender provided in the search"},"dateOfBirth":{"type":["string","null"],"description":"DOB provided in the search","format":"date"},"pepTiers":{"type":"array","items":{"type":["string","null"]},"description":"Pep Tiers provided in the search"},"scheduleId":{"type":["string","null"],"description":"Schedule Id linked to the search"},"isDobRequired":{"type":["boolean","null"],"description":"Indicates whether date of birth is required for the individual search.","default":true}}}},"components/schemas/KYCGetSearchIndividualBySearchIdResponse":{"id":"components/schemas/KYCGetSearchIndividualBySearchIdResponse","kind":"json-schema","title":"KYCGetSearchIndividualBySearchIdResponse","data":{"type":"object","properties":{"id":{"type":"string","description":"Id of the search","format":"uuid"},"name":{"type":["string","null"],"description":"Name provided for the search. Length must not exceed 200 characters"},"countryCodes":{"type":["array","null"],"items":{"type":"string"},"description":"Countries provided to the search"},"threshold":{"type":"integer","description":"Hits with scores below this value will not be shown.","format":"int32"},"type":{"type":"string","description":"Indicates whether search type is individual or business"},"datasets":{"type":"array","items":{"type":"string"},"description":"Provided datasets for the search"},"sanctionBodies":{"type":["array","null"],"items":{"type":"integer"},"description":"Provided sanctionBodies for the search"},"status":{"type":"string","description":"Status of the search"},"riskRating":{"type":"string","description":"The risk rating being assigned to the profile","enum":["notApplicable","veryLow","low","medium","high","veryHigh"]},"assignedToUserId":{"type":["integer","null"],"description":"Id of the user assigned to the search","format":"int32"},"assignedUser":{"type":["string","null"],"description":"Name of the user assigned to the search"},"createdById":{"type":"integer","description":"Id of the user who created the search","format":"int32"},"createdBy":{"type":"string","description":"Name of the user who created the search"},"createdAt":{"type":"string","description":"Search created date time","format":"date-time"},"modifiedById":{"type":"integer","description":"Id of the user who modified the search","format":"int32"},"modifiedBy":{"type":"string","description":"Name of the user who modified the search"},"modifiedAt":{"type":"string","description":"Search modified date time","format":"date-time"},"note":{"type":["string","null"],"description":"Note associated with the search"},"totalHitCount":{"type":"integer","description":"Total number of hits in the search","format":"int32"},"truePositiveHitsCount":{"type":"integer","description":"The number of true-positive hits in the search","format":"int32"},"falsePositiveHitsCount":{"type":"integer","description":"The number of false-positive hits in the search","format":"int32"},"undecidedHitsCount":{"type":"integer","description":"The number of undecided hits in the search","format":"int32"},"firstName":{"type":["string","null"],"description":"First name provided in the search.\r\nThe combination of first name, middle name, and last name must not exceed 200 characters"},"middleName":{"type":["string","null"],"description":"Middle name provided in the search.\r\nThe combination of first name, middle name, and last name must not exceed 200 characters"},"lastName":{"type":["string","null"],"description":"Last name provided in the search.\r\nThe combination of first name, middle name, and last name must not exceed 200 characters"},"gender":{"type":["string","null"],"description":"Gender provided in the search"},"dateOfBirth":{"type":["string","null"],"description":"DOB provided in the search","format":"date"},"pepTiers":{"type":["array","null"],"items":{"type":"string"},"description":"Pep Tiers provided in the search"},"scheduleId":{"type":["string","null"],"description":"Schedule Id linked to the search"},"isDobRequired":{"type":["boolean","null"],"description":"Indicates whether date of birth is required for the individual search.","default":true}}}},"components/schemas/PutKYCIndividualSearchBySearchIdRequest":{"id":"components/schemas/PutKYCIndividualSearchBySearchIdRequest","kind":"json-schema","title":"PutKYCIndividualSearchBySearchIdRequest","data":{"type":"object","required":["riskRating","status"],"properties":{"assignedToUserId":{"type":"integer","description":"Id of the User to assign to the Search","format":"int32"},"status":{"type":"string","description":"Status of the Search. Available values are new, approved, declined, pending, cancelled, referred and closed."},"riskRating":{"type":"string","description":"Risk rating of the Search and allowed values notApplicable,veryLow,low,medium,high and veryHigh"},"note":{"type":"string","description":"Note associated with the search"}}}},"components/schemas/KYCPutSearchIndividualBySearchIdResponse":{"id":"components/schemas/KYCPutSearchIndividualBySearchIdResponse","kind":"json-schema","title":"KYCPutSearchIndividualBySearchIdResponse","data":{"type":"object","properties":{"id":{"type":"string","description":"Id of the search","format":"uuid"},"name":{"type":"string","description":"Name provided for the search. Length must not exceed 200 characters"},"countryCodes":{"type":"array","description":"Countries provided to the search","items":{"type":"string"}},"threshold":{"type":"integer","description":"Hits with scores below this value will not be shown.","format":"int32"},"type":{"type":"string","description":"Indicates whether search type is individual or business"},"datasets":{"type":"array","description":"Provided datasets for the search","items":{"type":"string"}},"status":{"type":"string","description":"Status of the search"},"riskRating":{"type":"string","description":"The risk rating being assigned to the profile","enum":["notApplicable","veryLow","low","medium","high","veryHigh"]},"assignedToUserId":{"type":"integer","description":"Id of the user assigned to the search","format":"int32"},"assignedUser":{"type":"string","description":"Name of the user assigned to the search"},"createdById":{"type":"integer","description":"Id of the user who created the search","format":"int32"},"createdBy":{"type":"string","description":"Name of the user who created the search"},"createdAt":{"type":"string","description":"Search created date time","format":"date-time"},"modifiedById":{"type":"integer","description":"Id of the user who modified the search","format":"int32"},"modifiedBy":{"type":"string","description":"Name of the user who modified the search"},"modifiedAt":{"type":"string","description":"Search modified date time","format":"date-time"},"note":{"type":"string","description":"Note associated with the search"},"totalHitCount":{"type":"integer","description":"Total number of hits in the search","format":"int32"},"truePositiveHitsCount":{"type":"integer","description":"The number of true-positive hits in the search","format":"int32"},"falsePositiveHitsCount":{"type":"integer","description":"The number of false-positive hits in the search","format":"int32"},"undecidedHitsCount":{"type":"integer","description":"The number of undecided hits in the search","format":"int32"},"firstName":{"type":"string","description":"First name provided in the search.\r\nThe combination of first name, middle name, and last name must not exceed 200 characters"},"middleName":{"type":"string","description":"Middle name provided in the search.\r\nThe combination of first name, middle name, and last name must not exceed 200 characters"},"lastName":{"type":"string","description":"Last name provided in the search.\r\nThe combination of first name, middle name, and last name must not exceed 200 characters"},"gender":{"type":"string","description":"Gender provided in the search"},"dateOfBirth":{"type":"string","description":"DOB provided in the search","format":"date"},"pepTiers":{"type":"array","description":"Pep Tiers provided in the search","items":{"type":"string"}},"scheduleId":{"type":["string","null"],"description":"Schedule Id linked to the search"},"isDobRequired":{"type":["boolean","null"],"description":"Indicates whether date of birth is required for the individual search.","default":true},"correlationId":{"type":"string","description":"A unique ID assigned to this request."}}}},"components/schemas/KYCGetSearchIndividualsDownloadBySearchIdResponse":{"id":"components/schemas/KYCGetSearchIndividualsDownloadBySearchIdResponse","kind":"json-schema","title":"KYCGetSearchIndividualsDownloadBySearchIdResponse","data":{"type":"object","properties":{"searchId":{"type":"string","description":"Id of the search","format":"uuid"},"downloadUrl":{"type":"string","description":"Url of the file to download"},"fileName":{"type":"string","description":"Name of the file"},"expiresAt":{"type":"string","description":"Date and time when the url will expire","format":"date-time"}}}},"components/schemas/GetIndividualSearchIdHitsResponse":{"id":"components/schemas/GetIndividualSearchIdHitsResponse","kind":"json-schema","title":"GetIndividualSearchIdHitsResponse","data":{"properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The Id of the search hit.","format":"uuid"},"hitScore":{"type":"integer","description":"The hit score associated to the search hit.","format":"int32"},"name":{"type":["string","null"],"description":"The name associated to the search hit."},"match":{"type":["string","null"],"description":"The match string associated to the search hit."},"countries":{"type":["array","null"],"items":{"type":"string"},"description":"The countries associated to the search hit."},"datasets":{"type":"array","items":{"type":"string"},"description":"The datasets associated to the search hit."},"decision":{"type":"string","description":"The decision made on the search hit. Available values are undecided, trueMatch, falsePositive and discarded."},"note":{"type":["string","null"],"description":"The note added to the search hit."},"modifiedById":{"type":"integer","description":"The search hit last modified by user id.","format":"int32"},"modifiedBy":{"type":["string","null"],"description":"The search hit last modified by user name."},"modifiedAt":{"type":"string","description":"The search hit last modified date and time.","format":"date-time"},"createdAt":{"type":"string","description":"The search hit created date and time.","format":"date-time"},"firstName":{"type":["string","null"],"description":"The first name of the search hit."},"middleName":{"type":["string","null"],"description":"The middle name of the search hit."},"lastName":{"type":["string","null"],"description":"The last name of the search hit."},"gender":{"type":["string","null"],"description":"The gender associated to the search hit. (male, female)"},"datesOfBirth":{"type":["array","null"],"items":{"type":"string","description":"Can be in the format YYYY or YYYY-MM-DD","format":"date"},"description":"The dates of birth associated to the search hit."},"pepTier":{"type":["string","null"],"description":"The pep tier associated to the search hit. (pepTier1, pepTier2, pepTier3)"},"profileImages":{"type":["string","null"],"items":{"type":"string"},"description":"The profile images associated to the search hit."},"supersededHit":{"type":"object","properties":{"id":{"type":"string","description":"The Id of the search hit.","format":"uuid"},"hitScore":{"type":"integer","description":"The hit score associated to the search hit.","format":"int32"},"name":{"type":["string","null"],"description":"The name associated to the search hit."},"match":{"type":["string","null"],"description":"The match string associated to the search hit."},"countries":{"type":["array","null"],"items":{"type":"string"},"description":"The countries associated to the search hit."},"datasets":{"type":"array","items":{"type":"string"},"description":"The datasets associated to the search hit."},"decision":{"type":"string","description":"The decision made on the search hit. Available values are undecided, trueMatch, falsePositive and discarded."},"note":{"type":["string","null"],"description":"The note added to the search hit."},"modifiedById":{"type":"integer","description":"The search hit last modified by user id.","format":"int32"},"modifiedBy":{"type":["string","null"],"description":"The search hit last modified by user name."},"modifiedAt":{"type":"string","description":"The search hit last modified date and time.","format":"date-time"},"createdAt":{"type":"string","description":"The search hit created date and time.","format":"date-time"},"firstName":{"type":["string","null"],"description":"The first name of the search hit."},"middleName":{"type":["string","null"],"description":"The middle name of the search hit."},"lastName":{"type":["string","null"],"description":"The last name of the search hit."},"gender":{"type":["string","null"],"description":"The gender associated to the search hit. (male, female)"},"datesOfBirth":{"type":["array","null"],"items":{"type":"string","description":"Can be in the format YYYY or YYYY-MM-DD","format":"date"},"description":"The dates of birth associated to the search hit."},"pepTier":{"type":["string","null"],"description":"The pep tier associated to the search hit. (pepTier1, pepTier2, pepTier3)"},"profileImages":{"type":["array","null"],"items":{"type":"string"},"description":"The profile images associated to the search hit."}}}}}},"totalSize":{"type":"number"}}}},"components/schemas/IndividualSearchUpdateHitRequest":{"id":"components/schemas/IndividualSearchUpdateHitRequest","kind":"json-schema","title":"IndividualSearchUpdateHitRequest","data":{"type":"object","required":["hitId"],"properties":{"decision":{"type":["string","null"],"description":"The Decision of the Hit to be updated\r\nDecision can only be made once and allowed values are undecided,trueMatch and falsePositive"},"note":{"type":["string","null"],"description":"Note associated with the Hit"},"hitId":{"type":["string","null"],"description":"The Id of the Hit to be updated","format":"uuid"}},"additionalProperties":false}},"components/schemas/MODEL20274f":{"id":"components/schemas/MODEL20274f","kind":"json-schema","title":"MODEL20274f","data":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/IndividualSearchUpdateHitRequest"}}}}},"components/schemas/PutIndividualSearchIdHitsResponse":{"id":"components/schemas/PutIndividualSearchIdHitsResponse","kind":"json-schema","title":"PutIndividualSearchIdHitsResponse","data":{"type":"object","properties":{"failed":{"type":"array","items":{"type":"object","properties":{"failedItem":{"type":"object","properties":{"decision":{"description":"The Decision of the Hit to be updated Decision can only be made once. Available values are undecided, truematch, falsepositive, discarded","type":["string","null"]},"note":{"type":["string","null"],"description":"Note associated with the Hit"},"hitId":{"type":["string","null"],"description":"The Id of the Hit to be updated"}}},"error":{"type":"object","properties":{"type":{"type":["string","null"]},"title":{"type":["string","null"]},"status":{"type":["integer","null"]},"detail":{"type":["string","null"]},"instance":{"type":["string","null"]}}}}}},"successful":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The Id of the search hit.","format":"uuid"},"hitScore":{"type":"integer","description":"The hit score associated to the search hit.","format":"int32"},"name":{"type":["string","null"],"description":"The name associated to the search hit."},"match":{"type":["string","null"],"description":"The match string associated to the search hit."},"countries":{"type":["array","null"],"items":{"type":"string"},"description":"The countries associated to the search hit."},"datasets":{"type":"array","items":{"type":"string"},"description":"The datasets associated to the search hit."},"decision":{"type":"string","description":"The decision made on the search hit. Available values are undecided, trueMatch, falsePositive anddiscarded."},"note":{"type":["string","null"],"description":"The note added to the search hit."},"modifiedById":{"type":"integer","description":"The search hit last modified by user id.","format":"int32"},"modifiedBy":{"type":["string","null"],"description":"The search hit last modified by user name."},"modifiedAt":{"type":"string","description":"The search hit last modified date and time.","format":"date-time"},"createdAt":{"type":"string","description":"The search hit created date and time.","format":"date-time"},"firstName":{"type":["string","null"],"description":"The first name of the search hit."},"middleName":{"type":["string","null"],"description":"The middle name of the search hit."},"lastName":{"type":["string","null"],"description":"The last name of the search hit."},"gender":{"type":["string","null"],"description":"The gender associated to the search hit. (male, female)"},"datesOfBirth":{"type":["array","null"],"items":{"type":"string","description":"Can be in the format YYYY or YYYY-MM-DD","format":"date"},"description":"The dates of birth associated to the search hit."},"pepTier":{"type":["string","null"],"description":"The pep tier associated to the search hit. (pepTier1, pepTier2, pepTier3)"},"profileImages":{"type":["array","null"],"items":{"type":"string"},"description":"The profile images associated to the search hit."},"supersededHit":{"type":"object","properties":{"id":{"type":"string","description":"The Id of the search hit.","format":"uuid"},"hitScore":{"type":"integer","description":"The hit score associated to the search hit.","format":"int32"},"name":{"type":["string","null"],"description":"The name associated to the search hit."},"match":{"type":["string","null"],"description":"The match string associated to the search hit."},"countries":{"type":["array","null"],"items":{"type":"string"},"description":"The countries associated to the search hit."},"datasets":{"type":"array","items":{"type":"string"},"description":"The datasets associated to the search hit."},"decision":{"type":"string","description":"The decision made on the search hit. Available values are undecided, trueMatch, falsePositive and discarded."},"note":{"type":["string","null"],"description":"The note added to the search hit."},"modifiedById":{"type":"integer","description":"The search hit last modified by user id.","format":"int32"},"modifiedBy":{"type":["string","null"],"description":"The search hit last modified by user name."},"modifiedAt":{"type":"string","description":"The search hit last modified date and time.","format":"date-time"},"createdAt":{"type":["string","null"],"description":"The search hit created date and time."},"firstName":{"type":["string","null"],"description":"The first name of the search hit."},"middleName":{"type":["string","null"],"description":"The middle name of the search hit."},"lastName":{"type":["string","null"],"description":"The last name of the search hit."},"gender":{"type":["string","null"],"description":"The gender associated to the search hit. (male, female)"},"datesOfBirth":{"type":["array","null"],"items":{"type":"string","description":"Can be in the format YYYY or YYYY-MM-DD","format":"date"},"description":"The dates of birth associated to the search hit."},"pepTier":{"type":["string","null"],"description":"The pep tier associated to the search hit. (pepTier1, pepTier2, pepTier3)"},"profileImages":{"type":["array","null"],"items":{"type":"string"},"description":"The profile images associated to the search hit."}}}}}},"correlationId":{"type":"string","description":"A unique ID assigned to this request."}}}},"components/schemas/SearchResultHitsIdentifierResponse":{"id":"components/schemas/SearchResultHitsIdentifierResponse","kind":"json-schema","title":"SearchResultHitsIdentifierResponse","data":{"type":"object","properties":{"type":{"type":"string","description":"The type of the hit identifier."},"value":{"type":"string","description":"The value of the hit identifier."}}}},"components/schemas/SearchResultHitsAddressResponse":{"id":"components/schemas/SearchResultHitsAddressResponse","kind":"json-schema","title":"SearchResultHitsAddressResponse","data":{"type":"object","properties":{"postalCode":{"type":["string","null"],"description":"The postal code of the address."},"line1":{"type":["string","null"],"description":"The line1 of the address."},"line2":{"type":["string","null"],"description":"The line2 of the address."},"type":{"type":["string","null"],"description":"The type of the address."},"county":{"type":["string","null"],"description":"The county of the address."},"countryCode":{"type":["string","null"],"description":"The country code of the address."},"city":{"type":["string","null"],"description":"The city of the address."}},"additionalProperties":false}},"components/schemas/SearchResultHitsContactResponse":{"id":"components/schemas/SearchResultHitsContactResponse","kind":"json-schema","title":"SearchResultHitsContactResponse","data":{"type":"object","properties":{"type":{"enum":["telephone","fax","mobile","email","website"],"type":"string"},"value":{"type":"string"}},"additionalProperties":false}},"components/schemas/SearchResultHitsIndividualLinkResponse":{"id":"components/schemas/SearchResultHitsIndividualLinkResponse","kind":"json-schema","title":"SearchResultHitsIndividualLinkResponse","data":{"type":"object","properties":{"relationship":{"type":"string","description":"The relationship of the associated link."},"ownershipPercentage":{"type":["integer","null"],"description":"The ownership percentage of the associated link.","format":"int32"},"datasets":{"type":"array","items":{"type":"string"},"description":"The datasets associated with the link."},"firstName":{"type":["string","null"],"description":"The first name of the individual link."},"middleName":{"type":["string","null"],"description":"The middle name of the individual link."},"lastName":{"type":["string","null"],"description":"The last name of the individual link."}},"additionalProperties":false}},"components/schemas/SearchResultHitsBusinessLinkResponse":{"id":"components/schemas/SearchResultHitsBusinessLinkResponse","kind":"json-schema","title":"SearchResultHitsBusinessLinkResponse","data":{"type":"object","properties":{"relationship":{"type":"string","description":"The relationship of the associated link."},"ownershipPercentage":{"type":["integer","null"],"description":"The ownership percentage of the associated link.","format":"int32"},"datasets":{"type":"array","items":{"type":"string"},"description":"The datasets associated with the link."},"name":{"type":"string","description":"The name of the link."},"individualLinks":{"type":"array","items":{"$ref":"#/components/schemas/SearchResultHitsIndividualLinkResponse"},"description":"The individual links associated to the business link."}},"additionalProperties":false}},"components/schemas/SearchResultHitsSourceResponse":{"id":"components/schemas/SearchResultHitsSourceResponse","kind":"json-schema","title":"SearchResultHitsSourceResponse","data":{"type":"object","properties":{"title":{"type":["string","null"],"description":"The title of the hit source."},"description":{"type":["string","null"],"description":"The description of the hit source."},"link":{"type":["string","null"],"description":"The URL associated to the hit source."},"dateAdded":{"type":["string","null"],"description":"The date when the hit source is added.","format":"date"},"isCopyrighted":{"type":["string","null"],"description":"Represents whether hit source is copyrighted."},"datePublished":{"type":["string","null"],"description":"The date when hit source is published.","format":"date"},"documentLink":{"type":["string","null"],"description":"The document link associated to the hit source."},"datasets":{"type":["array","null"],"items":{"type":"string"},"description":"The datasets associated with the hit source."}},"additionalProperties":false}},"components/schemas/SearchResultHitsIndividualAliasResponse":{"id":"components/schemas/SearchResultHitsIndividualAliasResponse","kind":"json-schema","title":"SearchResultHitsIndividualAliasResponse","data":{"type":"object","properties":{"type":{"type":["string","null"]},"firstName":{"type":["string","null"]},"middleName":{"type":["string","null"]},"lastName":{"type":["string","null"]}},"additionalProperties":false}},"components/schemas/ApplicationSearchesModelsHitsEntriesDisqualifiedDirectorEntryValue":{"id":"components/schemas/ApplicationSearchesModelsHitsEntriesDisqualifiedDirectorEntryValue","kind":"json-schema","title":"ApplicationSearchesModelsHitsEntriesDisqualifiedDirectorEntryValue","data":{"type":"object","properties":{"referenceNumber":{"type":["string","null"]},"fromDate":{"type":["string","null"],"format":"date-time"},"toDate":{"type":["string","null"],"format":"date-time"},"organisations":{"type":["array","null"],"items":{"type":"string"}},"reason":{"type":"string"}}}},"components/schemas/WebApiModelsSearchesSearchResultHitsEntriesDisqualifiedDirectorEntryResponse":{"id":"components/schemas/WebApiModelsSearchesSearchResultHitsEntriesDisqualifiedDirectorEntryResponse","kind":"json-schema","title":"WebApiModelsSearchesSearchResultHitsEntriesDisqualifiedDirectorEntryResponse","data":{"type":"object","properties":{"events":{"type":["array","null"],"items":{"$ref":"#/components/schemas/WebApiModelsSearchesSearchResultHitsEntriesEventsHitEventResponse"}},"sources":{"type":["array","null"],"items":{"$ref":"#/components/schemas/WebApiModelsSearchesSearchResultHitsHitSourceResponse"}},"type":{"type":"string","description":"Available values are adverseMedia, disqualifiedDirector, insolvencyRegister, pep, pepLinked, profileOfInterest, enforcement, sanction, stateOwnedEnterprise"},"value":{"$ref":"#/components/schemas/ApplicationSearchesModelsHitsEntriesDisqualifiedDirectorEntryValue"}}}},"components/schemas/WebApiModelsSearchesSearchResultHitsEntriesPepEntryValueResponse":{"id":"components/schemas/WebApiModelsSearchesSearchResultHitsEntriesPepEntryValueResponse","kind":"json-schema","title":"WebApiModelsSearchesSearchResultHitsEntriesPepEntryValueResponse","data":{"type":"object","properties":{"country":{"type":"string"},"position":{"type":"string"},"fromDate":{"type":["string","null"],"description":"Can be in the format YYYY or YYYY-MM-DD","format":"date"},"toDate":{"type":["string","null"],"description":"Can be in the format YYYY or YYYY-MM-DD","format":"date"},"segment":{"type":"string"}}}},"components/schemas/WebApiModelsSearchesSearchResultHitsEntriesPepEntryResponse":{"id":"components/schemas/WebApiModelsSearchesSearchResultHitsEntriesPepEntryResponse","kind":"json-schema","title":"WebApiModelsSearchesSearchResultHitsEntriesPepEntryResponse","data":{"type":"object","properties":{"events":{"type":["array","null"],"items":{"$ref":"#/components/schemas/WebApiModelsSearchesSearchResultHitsEntriesEventsHitEventResponse"}},"sources":{"type":["array","null"],"items":{"$ref":"#/components/schemas/WebApiModelsSearchesSearchResultHitsHitSourceResponse"}},"type":{"type":"string","description":"Available values are adverseMedia, disqualifiedDirector, insolvencyRegister, pep, pepLinked, profileOfInterest, enforcement, sanction, stateOwnedEnterprise"},"value":{"$ref":"#/components/schemas/WebApiModelsSearchesSearchResultHitsEntriesPepEntryValueResponse"}}}},"components/schemas/WebApiModelsSearchesSearchResultHitsEntriesPepByAssociationEntryValueResponse":{"id":"components/schemas/WebApiModelsSearchesSearchResultHitsEntriesPepByAssociationEntryValueResponse","kind":"json-schema","title":"WebApiModelsSearchesSearchResultHitsEntriesPepByAssociationEntryValueResponse","data":{"type":"object","properties":{"firstName":{"type":["string","null"]},"middleName":{"type":["string","null"]},"lastName":{"type":"string"},"relationship":{"type":"string"},"ownershipPercentage":{"type":["integer","null"],"format":"int32"},"datasets":{"type":"array","items":{"type":"string"}}}}},"components/schemas/WebApiModelsSearchesSearchResultHitsEntriesPepByAssociationEntryResponse":{"id":"components/schemas/WebApiModelsSearchesSearchResultHitsEntriesPepByAssociationEntryResponse","kind":"json-schema","title":"WebApiModelsSearchesSearchResultHitsEntriesPepByAssociationEntryResponse","data":{"type":"object","properties":{"events":{"type":["array","null"],"items":{"$ref":"#/components/schemas/WebApiModelsSearchesSearchResultHitsEntriesEventsHitEventResponse"}},"sources":{"type":["array","null"],"items":{"$ref":"#/components/schemas/WebApiModelsSearchesSearchResultHitsHitSourceResponse"}},"type":{"type":"string","description":"Available values are adverseMedia, disqualifiedDirector, insolvencyRegister, pep, pepLinked, profileOfInterest, enforcement, sanction, stateOwnedEnterprise"},"value":{"$ref":"#/components/schemas/WebApiModelsSearchesSearchResultHitsEntriesPepByAssociationEntryValueResponse"}}}},"components/schemas/WebApiModelsSearchesSearchResultHitsHitAmlResultsPepsResponse":{"id":"components/schemas/WebApiModelsSearchesSearchResultHitsHitAmlResultsPepsResponse","kind":"json-schema","title":"WebApiModelsSearchesSearchResultHitsHitAmlResultsPepsResponse","data":{"type":"object","properties":{"CURRENT":{"type":"array","items":{"$ref":"#/components/schemas/WebApiModelsSearchesSearchResultHitsEntriesPepEntryResponse"}},"FORMER":{"type":"array","items":{"$ref":"#/components/schemas/WebApiModelsSearchesSearchResultHitsEntriesPepEntryResponse"}},"LINKED":{"type":"array","items":{"$ref":"#/components/schemas/WebApiModelsSearchesSearchResultHitsEntriesPepByAssociationEntryResponse"}}}}},"components/schemas/IndividualSearchResultHitResponse":{"id":"components/schemas/IndividualSearchResultHitResponse","kind":"json-schema","title":"IndividualSearchResultHitResponse","data":{"type":"object","properties":{"id":{"type":"string","description":"The Id of the search hit","format":"uuid"},"hitScore":{"type":"integer","description":"The hit score associated to the search hit.","format":"int32"},"name":{"type":"string","description":"The name associated to the search hit."},"match":{"type":"string","description":"The match string associated to the search hit."},"note":{"type":"string","description":"The note added to the search hit."},"countries":{"type":"array","items":{"type":"string"},"description":"The countries associated to the search hit."},"datasets":{"type":"array","items":{"type":"string"},"description":"The datasets associated to the search hit."},"profileImages":{"type":"array","items":{"type":"string"},"description":"The profile images associated to the search hit."},"screeningNotes":{"type":"array","items":{"type":"string"},"description":"The screening notes associated to the search hit."},"modifiedAt":{"type":"string","description":"The search hit modified date and time.","format":"date-time"},"modifiedById":{"type":"integer","description":"The search hit modified by user id.","format":"int32"},"modifiedBy":{"type":"string","description":"The search hit modified by user name."},"createdAt":{"type":"string","description":"The search hit created date and time.","format":"date-time"},"decision":{"enum":["undecided","trueMatch","falsePositive"],"type":"string","description":"The decision made on the search hit."},"identifiers":{"type":"array","items":{"$ref":"#/components/schemas/SearchResultHitsIdentifierResponse"},"description":"The identifiers associated to the search hit."},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/SearchResultHitsAddressResponse"},"description":"The addresses associated to the search hit."},"contacts":{"type":"array","items":{"$ref":"#/components/schemas/SearchResultHitsContactResponse"},"description":"The contact details associated to the search hit."},"businessLinks":{"type":"array","items":{"$ref":"#/components/schemas/SearchResultHitsBusinessLinkResponse"},"description":"The business links associated to the search hit."},"individualLinks":{"type":"array","items":{"$ref":"#/components/schemas/SearchResultHitsIndividualLinkResponse"},"description":"The individual links associated to the search hit."},"sources":{"type":"array","items":{"$ref":"#/components/schemas/SearchResultHitsSourceResponse"},"description":"The sources associated to the search hit."},"firstName":{"type":"string","description":"The first name of the individual search hit."},"middleName":{"type":"string","description":"The middle name of the individual search hit."},"lastName":{"type":"string","description":"The last name of the individual search hit."},"gender":{"enum":["male","female"],"type":["string","null"],"description":"The gender associated with the search hit."},"datesOfBirth":{"type":"array","items":{"type":"string","description":"Can be in the format YYYY or YYYY-MM-DD","format":"date"},"description":"The dates of birth associated to the search hit."},"isDeceased":{"type":"boolean","description":"The deceased status of the individual associated to the search hit"},"datesOfDeath":{"type":"array","items":{"type":"string","description":"Can be in the format YYYY or YYYY-MM-DD","format":"date"},"description":"The dates of death associated to the search hit."},"pepTier":{"enum":["tier1","tier2","tier3"],"type":"string","description":"The pep tier associated to the search hit."},"aliases":{"type":"array","items":{"$ref":"#/components/schemas/SearchResultHitsIndividualAliasResponse"},"description":"The aliases associated to the search hit."},"amlResults":{"type":"object","properties":{"AM":{"type":"array","items":{"$ref":"#/components/schemas/WebApiModelsSearchesSearchResultHitsEntriesAdverseMediaEntryResponse"}},"ENF":{"type":"array","items":{"$ref":"#/components/schemas/WebApiModelsSearchesSearchResultHitsEntriesEnforcementEntryResponse"}},"INS":{"type":"array","items":{"$ref":"#/components/schemas/WebApiModelsSearchesSearchResultHitsEntriesInsolvencyEntryResponse"}},"POI":{"type":"array","items":{"$ref":"#/components/schemas/WebApiModelsSearchesSearchResultHitsEntriesProfileOfInterestEntryResponse"}},"SAN":{"$ref":"#/components/schemas/WebApiModelsSearchesSearchResultHitsHitAmlResultsSanctionsResponse"},"DD":{"type":"array","items":{"$ref":"#/components/schemas/WebApiModelsSearchesSearchResultHitsEntriesDisqualifiedDirectorEntryResponse"}},"PEP":{"$ref":"#/components/schemas/WebApiModelsSearchesSearchResultHitsHitAmlResultsPepsResponse"}}}}}},"components/schemas/IndividualsSearchResultUpdateHits":{"id":"components/schemas/IndividualsSearchResultUpdateHits","kind":"json-schema","title":"IndividualsSearchResultUpdateHits","data":{"type":"object","properties":{"decision":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Decision of the Hit to be updated. The Decision can only be made once. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allowed values are undecided,trueMatch and falsePositive"},"children":[]}]}]}]},"note":{"type":"string","description":"Note associated with the Hit"}}}},"components/schemas/PutIndividualSearchIdHitsByHitIdResponse":{"id":"components/schemas/PutIndividualSearchIdHitsByHitIdResponse","kind":"json-schema","title":"PutIndividualSearchIdHitsByHitIdResponse","data":{"properties":{"items":{"type":"object","properties":{"id":{"type":"string","description":"The Id of the search hit.","format":"uuid"},"hitScore":{"type":"integer","description":"The hit score associated to the search hit.","format":"int32"},"name":{"type":["string","null"],"description":"The name associated to the search hit."},"match":{"type":["string","null"],"description":"The match string associated to the search hit."},"countries":{"type":["array","null"],"items":{"type":"string"},"description":"The countries associated to the search hit."},"datasets":{"type":"array","items":{"type":"string"},"description":"The datasets associated to the search hit."},"decision":{"type":"string","description":"The decision made on the search hit. Available values are undecided, trueMatch, falsePositive and discarded."},"note":{"type":["string","null"],"description":"The note added to the search hit."},"modifiedById":{"type":"integer","description":"The search hit last modified by user id.","format":"int32"},"modifiedBy":{"type":["string","null"],"description":"The search hit last modified by user name."},"modifiedAt":{"type":"string","description":"The search hit last modified date and time.","format":"date-time"},"createdAt":{"type":"string","description":"The search hit created date and time.","format":"date-time"},"firstName":{"type":["string","null"],"description":"The first name of the search hit."},"middleName":{"type":["string","null"],"description":"The middle name of the search hit."},"lastName":{"type":["string","null"],"description":"The last name of the search hit."},"gender":{"type":["string","null"],"description":"The gender associated to the search hit. (male, female)"},"datesOfBirth":{"type":["array","null"],"items":{"type":"string","description":"Can be in the format YYYY or YYYY-MM-DD","format":"date"},"description":"The dates of birth associated to the search hit."},"pepTier":{"type":["string","null"],"description":"The pep tier associated to the search hit. (pepTier1, pepTier2, pepTier3, byAssociation)"},"profileImages":{"type":["string","null"],"items":{"type":"string"},"description":"The profile images associated to the search hit."},"supersededHit":{"type":"object","properties":{"id":{"type":"string","description":"The Id of the search hit.","format":"uuid"},"hitScore":{"type":"integer","description":"The hit score associated to the search hit.","format":"int32"},"name":{"type":["string","null"],"description":"The name associated to the search hit."},"match":{"type":["string","null"],"description":"The match string associated to the search hit."},"countries":{"type":["array","null"],"items":{"type":"string"},"description":"The countries associated to the search hit."},"datasets":{"type":"array","items":{"type":"string"},"description":"The datasets associated to the search hit."},"decision":{"type":"string","description":"The decision made on the search hit. Available values are undecided, trueMatch, falsePositive and discarded."},"note":{"type":["string","null"],"description":"The note added to the search hit."},"modifiedById":{"type":"integer","description":"The search hit last modified by user id.","format":"int32"},"modifiedBy":{"type":["string","null"],"description":"The search hit last modified by user name."},"modifiedAt":{"type":"string","description":"The search hit last modified date and time.","format":"date-time"},"createdAt":{"type":"string","description":"The search hit created date and time.","format":"date-time"},"firstName":{"type":["string","null"],"description":"The first name of the search hit."},"middleName":{"type":["string","null"],"description":"The middle name of the search hit."},"lastName":{"type":["string","null"],"description":"The last name of the search hit."},"gender":{"type":["string","null"],"description":"The gender associated to the search hit. (male, female)"},"datesOfBirth":{"type":["array","null"],"items":{"type":"string","description":"Can be in the format YYYY or YYYY-MM-DD","format":"date"},"description":"The dates of birth associated to the search hit."},"pepTier":{"type":["string","null"],"description":"The pep tier associated to the search hit. (pepTier1, pepTier2, pepTier3, byAssociation)"},"profileImages":{"type":["array","null"],"items":{"type":"string"},"description":"The profile images associated to the search hit."}}}}}}}},"components/schemas/IndividualsSearchNoteResultUpdatetHits":{"id":"components/schemas/IndividualsSearchNoteResultUpdatetHits","kind":"json-schema","title":"IndividualsSearchNoteResultUpdatetHits","data":{"type":"object","properties":{"note":{"type":["string","null"],"description":"Note associated with the Hit"}}}},"components/schemas/KycProtectGetMonitoredSearchesDownloadResponse":{"id":"components/schemas/KycProtectGetMonitoredSearchesDownloadResponse","kind":"json-schema","title":"KycProtectGetMonitoredSearchesDownloadResponse","data":{"type":"object","properties":{"downloadUrl":{"type":"string","description":"Url of the file to download"},"fileName":{"type":"string","description":"Name of the file"},"expiresAt":{"type":"string","description":"Date and time when the url will expire","format":"date-time"}},"additionalProperties":false}},"components/schemas/GetKYCSearchLinksBySupplierHitId":{"id":"components/schemas/GetKYCSearchLinksBySupplierHitId","kind":"json-schema","title":"GetKYCSearchLinksBySupplierHitId","data":{"type":"object","properties":{"supplierHitId":{"type":"string","description":"The supplier hit id associated to the search hit"},"countries":{"type":"array","description":"The countries associated to the search hit.","items":{"type":"string"}},"datasets":{"type":"array","description":"The datasets associated to the search hit.","items":{"type":"string"}},"profileImages":{"type":"array","description":"The profile images associated to the search hit.","items":{"type":"string"}},"screeningNotes":{"type":"array","description":"The screening notes associated to the search hit.","items":{"type":"string"}},"identifiers":{"type":"array","description":"The identifiers associated to the search hit.","items":{"type":"object","properties":{"type":{"type":"string"},"value":{"type":"string"}}}},"addresses":{"type":"array","description":"The addresses associated to the search hit.","items":{"type":"object","properties":{"postalCode":{"type":"string","description":"The postal code of the address."},"line1":{"type":"string","description":"The line1 of the address."},"line2":{"type":"string","description":"The line2 of the address."},"type":{"type":"string","description":"The type of the address."},"county":{"type":"string","description":"The county of the address."},"countryCode":{"type":"string","description":"The country code of the address."},"city":{"type":"string","description":"The city of the address."}}}},"contacts":{"type":"array","description":"The contacts associated to the search hit.","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":"Available option -  "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"telephone"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fax"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mobile"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"website"},"children":[]}]}]}]},"value":{"type":"string"}}}},"businessLinks":{"type":"array","description":"The business links associated to the search hit.","items":{"type":"object","properties":{"relationship":{"type":"string","description":"The relationship of the associated link."},"supplierHitId":{"type":"string","description":"The supplier hit id of the associated link."},"ownershipPercentage":{"type":"number","description":"The ownership percentage of the associated link."},"datasets":{"type":"array","description":"The datasets associated with the link.","items":{"type":"string"}},"name":{"type":"string","description":"The name of the link."},"individualLinks":{"type":"array","description":"The individual links associated to the business link.","items":{"type":"object","properties":{"relationship":{"type":"string","description":"The relationship of the associated link."},"supplierHitId":{"type":"string","description":"The supplier hit id of the associated link."},"ownershipPercentage":{"type":"number","description":"The ownership percentage of the associated link."},"datasets":{"type":"array","description":"The datasets associated with the link.","items":{"type":"string"}},"firstName":{"type":"string","description":"The first name of the individual link."},"middleName":{"type":"string","description":"The middle name of the individual link."},"lastName":{"type":"string","description":"The last name of the individual link."}}}}}}},"individualLinks":{"type":"array","description":"The individual links associated to the search hit.","items":{"type":"object","properties":{"relationship":{"type":"string","description":"The relationship of the associated link."},"supplierHitId":{"type":"string","description":"The supplier hit id of the associated link."},"ownershipPercentage":{"type":"number","description":"The ownership percentage of the associated link."},"datasets":{"type":"array","description":"The datasets associated with the link.","items":{"type":"string"}},"firstName":{"type":"string","description":"The first name of the individual link."},"middleName":{"type":"string","description":"The middle name of the individual link."},"lastName":{"type":"string","description":"The last name of the individual link."}}}},"sources":{"type":"array","description":"The sources associated to the search hit.","items":{"type":"object","properties":{"id":{"type":"string","description":"The id of the hit source."},"title":{"type":"string","description":"The title of the hit source."},"description":{"type":"string","description":"The description of the hit source."},"link":{"type":"string","description":"The URL associated to the hit source."},"dateAdded":{"type":"string","description":"The date when the hit source is added."},"isCopyrighted":{"type":"boolean","description":"Represents whether hit source is copyrighted."},"datePublished":{"type":"string","description":"The date when hit source is published."},"documentLink":{"type":"string","description":"The document link associated to the hit source."},"datasets":{"type":"array","description":"The datasets associated with the hit source.","items":{"type":"string"}}}}},"name":{"type":"string","description":"The name associated to the search hit."},"activities":{"type":"array","description":"The activities associated to the search hit.","items":{"type":"string"}},"description":{"type":"string","description":"The description associated to the search hit."},"businessTypes":{"type":"array","description":"The business types associated to the search hit.","items":{"type":"string"}},"aliases":{"type":"array","description":"The aliases associated to the search hit.","items":{"type":"object","properties":{"type":{"type":"string"},"name":{"type":"string"}}}},"amlResults":{"type":"object","description":"The AML results associated to the search hit.","properties":{"AM":{"type":"array","items":{"$ref":"#/components/schemas/WebApiModelsSearchesSearchResultHitsEntriesAdverseMediaEntryResponse"}},"ENF":{"type":"array","items":{"$ref":"#/components/schemas/WebApiModelsSearchesSearchResultHitsEntriesEnforcementEntryResponse"}},"INS":{"type":"array","items":{"$ref":"#/components/schemas/WebApiModelsSearchesSearchResultHitsEntriesInsolvencyEntryResponse"}},"POI":{"type":"array","items":{"$ref":"#/components/schemas/WebApiModelsSearchesSearchResultHitsEntriesProfileOfInterestEntryResponse"}},"SAN":{"$ref":"#/components/schemas/WebApiModelsSearchesSearchResultHitsHitAmlResultsSanctionsResponse"},"SOE":{"$ref":"#/components/schemas/WebApiModelsSearchesSearchResultHitsEntriesStateOwnedEnterpriseEntryResponse"}}}}}},"components/schemas/PostKYCSearchLinksBySupplierHitIdDownloadResponse":{"id":"components/schemas/PostKYCSearchLinksBySupplierHitIdDownloadResponse","kind":"json-schema","title":"PostKYCSearchLinksBySupplierHitIdDownloadResponse","data":{"type":"object","properties":{"downloadUrl":{"type":"string","description":"Url of the file to download"},"fileName":{"type":"string","description":"Name of the file"},"expiresAt":{"type":"string","description":"Date and time when the url will expire","format":"date-time"}}}},"components/schemas/KYCGetSettingsPreferencesAmlResponse":{"id":"components/schemas/KYCGetSettingsPreferencesAmlResponse","kind":"json-schema","title":"KYCGetSettingsPreferencesAmlResponse","data":{"type":"object","properties":{"customerId":{"type":"integer","format":"int32","description":"The unique identifier for the customer associated with these AML settings."},"searchType":{"type":"string","description":"The type of AML search performed (e.g., screening, monitoring)."},"searchActionType":{"type":"string","description":"The action type for the AML search (e.g., initial, update)."},"threshold":{"type":"integer","format":"int32","description":"The threshold value used for AML screening or monitoring decisions."},"datasets":{"type":"array","items":{"type":"string"},"description":"The list of datasets included in the AML search or monitoring process."},"sanctionBodies":{"type":["array","null"],"items":{"type":"integer","format":"int32"},"description":"The list of sanction body IDs used for AML screening. May be null if not set."},"isEmailRequired":{"type":["boolean","null"],"description":"Indicates whether email notifications are required for AML events. May be null if not set."},"emailRecipients":{"type":["array","null"],"items":{"type":"string"},"description":"The list of email addresses to receive AML notifications. May be null if not set."},"pepTiers":{"type":["array","null"],"items":{"type":"string"},"description":"The list of PEP (Politically Exposed Person) tiers included in the AML screening. May be null if not set."},"createdAt":{"type":["string","null"],"format":"date-time","description":"The date and time when these AML settings were created. May be null if not set."},"createdById":{"type":["integer","null"],"format":"int32","description":"The user ID of the person who created these AML settings. May be null if not set."},"modifiedAt":{"type":["string","null"],"format":"date-time","description":"The date and time when these AML settings were last modified. May be null if not set."},"modifiedById":{"type":["integer","null"],"format":"int32","description":"The user ID of the person who last modified these AML settings. May be null if not set."},"correlationId":{"type":"string","description":"A unique ID assigned to this request for tracking and troubleshooting purposes."}}}},"components/schemas/PutKYCSettingsPreferencesAmlRequestBody":{"id":"components/schemas/PutKYCSettingsPreferencesAmlRequestBody","kind":"json-schema","title":"PutKYCSettingsPreferencesAmlRequestBody","data":{"required":["threshold","searchType","searchActionType","datasets"],"type":"object","properties":{"threshold":{"type":"integer","format":"int32","description":"The threshold score value used for AML screening decisions. Higher values require stronger matches to trigger alerts."},"searchType":{"type":"string","enum":["individual","business"],"description":"The type of AML search to perform. Valid values are \"individual\" for person searches and \"business\" for company searches."},"searchActionType":{"type":"string","enum":["screening","monitoring"],"description":"The action type for the AML search. Valid values are \"screening\" for one-time checks and \"monitoring\" for ongoing surveillance."},"pepTiers":{"type":"array","items":{"type":"string","enum":["pepTier1","pepTier2","pepTier3","byAssociation"]},"description":"Array of PEP (Politically Exposed Person) tier classifications to include in AML screening. Valid values are pepTier1, pepTier2, pepTier3 and byAssociation."},"datasets":{"type":"array","items":{"type":"string"},"description":"Array of dataset names to include in the AML search. Specifies which data sources should be checked during screening."},"sanctionBodies":{"type":["array","null"],"items":{"type":"integer","format":"int32"},"description":"Array of sanction body IDs to include in the AML screening. May be null to use default sanction bodies or if not applicable."},"isEmailRequired":{"type":["boolean","null"],"description":"Indicates whether email notifications are required for AML events and alerts. May be null to use system defaults."},"emailRecipients":{"type":["array","null"],"items":{"type":"string"},"description":"Array of email addresses to receive AML notifications and alerts. May be null if email notifications are disabled."}}}},"components/schemas/CreditsafeGlobalDataReportsConsumerConsumerInformationAdditionalData":{"id":"components/schemas/CreditsafeGlobalDataReportsConsumerConsumerInformationAdditionalData","kind":"json-schema","title":"CreditsafeGlobalDataReportsConsumerConsumerInformationAdditionalData","data":{"allOf":[{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsAdditionalData"},{"type":"object"}]}},"components/schemas/CreditsafeGlobalDataReportsConsumerConsumerInformation":{"id":"components/schemas/CreditsafeGlobalDataReportsConsumerConsumerInformation","kind":"json-schema","title":"CreditsafeGlobalDataReportsConsumerConsumerInformation","data":{"type":"object","properties":{"name":{"type":"string"},"firstName":{"type":"string"},"surname":{"type":"string"},"age":{"type":["integer","null"],"format":"int32"},"dateOfBirth":{"type":["string","null"],"format":"date-time"},"gender":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsGender"},"consumerID":{"type":"string"},"address":{"$ref":"#/components/schemas/CreditsafeGlobalDataAddressData"},"additionalData":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsConsumerConsumerInformationAdditionalData"}}}},"components/schemas/CreditsafeGlobalDataReportsConsumerConsumerIncome":{"id":"components/schemas/CreditsafeGlobalDataReportsConsumerConsumerIncome","kind":"json-schema","title":"CreditsafeGlobalDataReportsConsumerConsumerIncome","data":{"type":"object","properties":{"incomeYear":{"type":"integer","format":"int32"},"taxClass":{"type":"string"},"netWealth":{"type":["number","null"],"format":"double"},"netIncome":{"type":["number","null"],"format":"double"},"sumTax":{"type":["number","null"],"format":"double"},"grossIncome":{"type":["number","null"],"format":"double"},"municipalityNr":{"type":"string"}}}},"components/schemas/CreditsafeGlobalDataReportsConsumerConsumerDirectorship":{"id":"components/schemas/CreditsafeGlobalDataReportsConsumerConsumerDirectorship","kind":"json-schema","title":"CreditsafeGlobalDataReportsConsumerConsumerDirectorship","data":{"type":"object","properties":{"companyName":{"type":"string"},"companyStatus":{"type":"string"},"appointmentDate":{"type":["string","null"],"format":"date-time"},"turnover":{"type":["number","null"],"format":"double"},"creditRating":{"type":"string"},"companyNumber":{"type":"string"},"function":{"type":"string"},"companyRegistrationDate":{"type":["string","null"],"format":"date-time"},"netWorth":{"type":["number","null"],"format":"double"},"creditLimit":{"type":["number","null"],"format":"double"}}}},"components/schemas/CreditsafeGlobalDataReportsConsumerConsumerPaymentSummary":{"id":"components/schemas/CreditsafeGlobalDataReportsConsumerConsumerPaymentSummary","kind":"json-schema","title":"CreditsafeGlobalDataReportsConsumerConsumerPaymentSummary","data":{"type":"object","properties":{"unsettledROPNumber":{"type":["integer","null"],"format":"int32"},"partlySettledROPNumber":{"type":["integer","null"],"format":"int32"},"voluntaryPledgeNumber":{"type":["integer","null"],"format":"int32"},"unsettledROPAmount":{"type":["number","null"],"format":"double"},"partlySettledROPAmount":{"type":["number","null"],"format":"double"},"voluntaryPledgeAmount":{"type":["number","null"],"format":"double"}}}},"components/schemas/CreditsafeGlobalDataReportsConsumerConsumerRemarkOfPayment":{"id":"components/schemas/CreditsafeGlobalDataReportsConsumerConsumerRemarkOfPayment","kind":"json-schema","title":"CreditsafeGlobalDataReportsConsumerConsumerRemarkOfPayment","data":{"type":"object","properties":{"type":{"type":"string"},"date":{"type":["string","null"],"format":"date-time"},"source":{"type":"string"},"refNr":{"type":"string"},"amount":{"type":["number","null"],"format":"double"},"creditor":{"type":"string"},"status":{"type":"string"}}}},"components/schemas/CreditsafeGlobalDataReportsConsumerConsumerCreditRating":{"id":"components/schemas/CreditsafeGlobalDataReportsConsumerConsumerCreditRating","kind":"json-schema","title":"CreditsafeGlobalDataReportsConsumerConsumerCreditRating","data":{"type":"object","properties":{"providerValue":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsRangeDescribedValue_1_SystemString"},"providerDescription":{"type":"string"}}}},"components/schemas/CreditsafeGlobalDataReportsConsumerConsumerCreditScore":{"id":"components/schemas/CreditsafeGlobalDataReportsConsumerConsumerCreditScore","kind":"json-schema","title":"CreditsafeGlobalDataReportsConsumerConsumerCreditScore","data":{"type":"object","properties":{"currentCreditRating":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsConsumerConsumerCreditRating"},"currentContractLimit":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsFinancialValue_1_SystemDecimal"},"previousCreditRating":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsCreditRating"},"latestRatingChangeDate":{"type":["string","null"],"format":"date-time"}}}},"components/schemas/CreditsafeGlobalDataReportsConsumerConsumerAdditionalInformation":{"id":"components/schemas/CreditsafeGlobalDataReportsConsumerConsumerAdditionalInformation","kind":"json-schema","title":"CreditsafeGlobalDataReportsConsumerConsumerAdditionalInformation","data":{"type":"object"}},"components/schemas/CreditsafeGlobalDataReportsConsumerConsumerReport":{"id":"components/schemas/CreditsafeGlobalDataReportsConsumerConsumerReport","kind":"json-schema","title":"CreditsafeGlobalDataReportsConsumerConsumerReport","data":{"type":"object","properties":{"language":{"type":"string","description":"Language code for the consumer data (e.g., EN, DE)."},"consumerInformation":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsConsumerConsumerInformation"},"incomes":{"type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsConsumerConsumerIncome"}},"registeredProperty":{"type":["integer","null"],"format":"int32"},"registeredHousingShare":{"type":["integer","null"],"format":"int32"},"directorships":{"type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsConsumerConsumerDirectorship"}},"paymentRemarks":{"type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsConsumerConsumerPaymentSummary"}},"paymentRemarksDetails":{"type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsConsumerConsumerRemarkOfPayment"}},"voluntaryPledges":{"type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsConsumerConsumerRemarkOfPayment"}},"consumerRating":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsConsumerConsumerCreditScore"},"additionalInformation":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsConsumerConsumerAdditionalInformation"}}}},"components/schemas/CreditsafeGlobalDataReportsConsumerCriteriaSet":{"id":"components/schemas/CreditsafeGlobalDataReportsConsumerCriteriaSet","kind":"json-schema","title":"CreditsafeGlobalDataReportsConsumerCriteriaSet","data":{"properties":{"countries":{"type":"array","items":{"type":"string","example":"DE"}},"criteriaSets":{"type":"array","items":{"type":"object"}}}}},"components/schemas/CreditsafeGlobalDataReportsConsumerCsusAddress":{"id":"components/schemas/CreditsafeGlobalDataReportsConsumerCsusAddress","kind":"json-schema","title":"CreditsafeGlobalDataReportsConsumerCsusAddress","data":{"type":"object","properties":{"type":{"type":"string","description":"Type of address (current/former)"},"simpleValue":{"type":"string","description":"Consumer's full address"},"street":{"type":"string","description":"Street Name of the Consumer's address"},"houseNumber":{"type":"string","description":"House Number of the Consumer's address"},"city":{"type":"string","description":"City of the Consumer's address"},"postalCode":{"type":"string","description":"ZIP code of the Consumer's address"},"province":{"type":"string","description":"State of the Consumer's address"},"telephoneNumber":{"type":"string","description":"Telephone Number of the Consumer"},"country":{"type":"string","description":"Country of the Consumer's address"},"dateFrom":{"type":["string","null"],"format":"date-time","description":"Date the Consumer's address was first reported"}}}},"components/schemas/CreditsafeGlobalDataReportsConsumerCsusConsumerInformation":{"id":"components/schemas/CreditsafeGlobalDataReportsConsumerCsusConsumerInformation","kind":"json-schema","title":"CreditsafeGlobalDataReportsConsumerCsusConsumerInformation","data":{"type":"object","properties":{"name":{"type":"string","description":"Full name of the Consumer"},"firstName":{"type":"string","description":"First name of the Consumer"},"middleName":{"type":"string","description":"Middle name(s) of the Consumer"},"surname":{"type":"string","description":"Surname of the Consumer"},"age":{"type":["integer","null"],"format":"int32","description":"Age of Consumer"},"dateOfBirth":{"type":["string","null"],"format":"date-time","description":"Consumer's Date of Birth"},"gender":{"type":"string","description":"Consumer's Gender"},"consumerID":{"type":"string","description":"Consumer's consumer ID"},"address":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsConsumerCsusAddress"}}}},"components/schemas/CreditsafeGlobalDataReportsConsumerCsusCurrentCreditRating":{"id":"components/schemas/CreditsafeGlobalDataReportsConsumerCsusCurrentCreditRating","kind":"json-schema","title":"CreditsafeGlobalDataReportsConsumerCsusCurrentCreditRating","data":{"type":"object","properties":{"providerValue":{"type":"object","properties":{"modelNumber":{"type":"string","description":"Model Number of the specific scoring model used"},"modelName":{"type":"string","description":"Name of the scoring model"},"value":{"type":"string","description":"Actual Credit Score"}}},"providerDescriptions":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","description":"Numerical code applied for credit score reasons"},"description":{"type":"string","description":"A commentary that provides reasons behind the credit score produced"}}}}}}},"components/schemas/CreditsafeGlobalDataReportsConsumerCsusCreditScoreExtra":{"id":"components/schemas/CreditsafeGlobalDataReportsConsumerCsusCreditScoreExtra","kind":"json-schema","title":"CreditsafeGlobalDataReportsConsumerCsusCreditScoreExtra","data":{"type":"object","properties":{"currentCreditRatings":{"type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsConsumerCsusCurrentCreditRating"}}}}},"components/schemas/CreditsafeGlobalDataReportsConsumerCsusAddressAdditionalData":{"id":"components/schemas/CreditsafeGlobalDataReportsConsumerCsusAddressAdditionalData","kind":"json-schema","title":"CreditsafeGlobalDataReportsConsumerCsusAddressAdditionalData","data":{"type":"object","properties":{"poBox":{"type":["boolean","null"],"description":"Indicator that shows if the address is a PO Box"},"rentOwnBuy":{"type":"string","description":"Rent, Own or Buy flag for the specific address/property"},"addressSource":{"type":"string","description":"The source of the address"},"dateLastReported":{"type":["string","null"],"format":"date-time","description":"The date the address was last reported by the Consumer"}}}},"components/schemas/CreditsafeGlobalDataReportsConsumerCsusContactAddress":{"id":"components/schemas/CreditsafeGlobalDataReportsConsumerCsusContactAddress","kind":"json-schema","title":"CreditsafeGlobalDataReportsConsumerCsusContactAddress","data":{"allOf":[{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsConsumerCsusAddress"},{"type":"object","properties":{"additionalData":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsConsumerCsusAddressAdditionalData"}}}]}},"components/schemas/CreditsafeGlobalDataReportsConsumerCsusContactInformation":{"id":"components/schemas/CreditsafeGlobalDataReportsConsumerCsusContactInformation","kind":"json-schema","title":"CreditsafeGlobalDataReportsConsumerCsusContactInformation","data":{"type":"object","properties":{"mainAddress":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsConsumerCsusContactAddress"},"previousAddresses":{"type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsConsumerCsusContactAddress"}}}}},"components/schemas/CreditsafeGlobalDataReportsConsumerCsusPotentiallyNegativeInformation":{"id":"components/schemas/CreditsafeGlobalDataReportsConsumerCsusPotentiallyNegativeInformation","kind":"json-schema","title":"CreditsafeGlobalDataReportsConsumerCsusPotentiallyNegativeInformation","data":{"type":"object","properties":{"collections":{"type":["integer","null"],"format":"int32","description":"Number of collections"},"thirtyDayDelinquent":{"type":["integer","null"],"format":"int32","description":"Number of payments over due by 30-59 days"},"sixtyDayDelinquent":{"type":["integer","null"],"format":"int32","description":"Number of payments over due by 60-90 days"},"ninetyDayDelinquent":{"type":["integer","null"],"format":"int32","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of payments over due by 90+ days"},"children":[]}]}]}]},"chargeOffAccounts":{"type":["integer","null"],"format":"int32","description":"Number of accounts that have been charged-off for the Consumer"},"bankruptcyAccounts":{"type":["integer","null"],"format":"int32","description":"Number of accounts the Consumer has in bankruptcy"},"foreclosureAccounts":{"type":["integer","null"],"format":"int32","description":"Number of accounts the Consumer has in foreclosure"},"vehicleRepossessions":{"type":["integer","null"],"format":"int32","description":"Number of vehicle repossessions for the Consumer"},"potentialFraud":{"type":["boolean","null"],"description":"Potential Fraudulence indicator"}}}},"components/schemas/CreditsafeGlobalDataReportsConsumerCsusBankruptcy":{"id":"components/schemas/CreditsafeGlobalDataReportsConsumerCsusBankruptcy","kind":"json-schema","title":"CreditsafeGlobalDataReportsConsumerCsusBankruptcy","data":{"type":"object","properties":{"customerNumber":{"type":"string","description":"The Customer Number assigned to the Consumer"},"caseNumber":{"type":"string","description":"The Case Number assigned to the bankruptcy"},"type":{"type":"string","description":"Type of bankruptcy e.g. individual, other etc."},"dateFiled":{"type":["string","null"],"format":"date-time","description":"The Date the bankruptcy was filed"},"assetAmount":{"type":["number","null"],"format":"double","description":"The value of assets that are part of the bankruptcy estate"},"exemptAmount":{"type":["number","null"],"format":"double","description":"The value of assets that are not part of the bankruptcy estate"},"liabilityAmount":{"type":["number","null"],"format":"double","description":"Total amounts owed to creditors"},"filer":{"type":"string","description":"The filer of the bankruptcy e.g. Individual, Joint, Spouse etc."},"industryCode":{"type":"string","description":"Industry Code"},"industryDescription":{"type":"string","description":"Industry Description"},"comments":{"type":"string","description":"Additional Comments relating to the bankruptcy"}}}},"components/schemas/CreditsafeGlobalDataReportsConsumerCsusCollection":{"id":"components/schemas/CreditsafeGlobalDataReportsConsumerCsusCollection","kind":"json-schema","title":"CreditsafeGlobalDataReportsConsumerCsusCollection","data":{"type":"object","properties":{"customerNumber":{"type":"string","description":"Customer Number assigned to the collection"},"clientNameOrNumber":{"type":"string","description":"Client Name or Number"},"balance":{"type":["number","null"],"format":"double","description":"Amount owed at the time of reporting"},"balanceDate":{"type":["string","null"],"format":"date-time","description":"Date the balance was last reported"},"status":{"type":"string","description":"Status of the collection"},"statusDate":{"type":["string","null"],"format":"date-time","description":"The date the status was last updated"},"dateReported":{"type":["string","null"],"format":"date-time","description":"The date the collection was reported"},"dateAssigned":{"type":["string","null"],"format":"date-time","description":"The date the collection was assigned"},"originalAmount":{"type":["number","null"],"format":"double","description":"Original Amount owed to the collection agency"},"lastActivityDate":{"type":["string","null"],"format":"date-time","description":"The date the collection was last updated"},"accountOwner":{"type":"string","description":"The creditor that holds legal rights to the collection"},"industryCode":{"type":"string","description":"Industry Code"},"industryDescription":{"type":"string","description":"Industry Description"},"comments":{"type":"string","description":"Additional comments relating to the collection"}}}},"components/schemas/CreditsafeGlobalDataReportsConsumerCsusNegativeInformation":{"id":"components/schemas/CreditsafeGlobalDataReportsConsumerCsusNegativeInformation","kind":"json-schema","title":"CreditsafeGlobalDataReportsConsumerCsusNegativeInformation","data":{"type":"object","properties":{"potentiallyNegativeInformation":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsConsumerCsusPotentiallyNegativeInformation"},"bankruptcies":{"type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsConsumerCsusBankruptcy"}},"collections":{"type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsConsumerCsusCollection"}}}}},"components/schemas/CreditsafeGlobalDataReportsConsumerCsusMisc":{"id":"components/schemas/CreditsafeGlobalDataReportsConsumerCsusMisc","kind":"json-schema","title":"CreditsafeGlobalDataReportsConsumerCsusMisc","data":{"type":"object","properties":{"reportDate":{"type":["string","null"],"format":"date-time","description":"The date the report was created"},"lastActivityDate":{"type":["string","null"],"format":"date-time","description":"The date the report was last updated"},"stateOfIssuance":{"type":"string","description":"The state where a specific document or identifier was issued for the Consumer"},"yearOfIssuance":{"type":"string","description":"The year when a specific document or identifier was issued for the Consumer"},"subjectSSN":{"type":"string","description":"The Consumer's person number"},"ssnMatch":{"type":"string","description":"Verifies that the person number is linked to the Consumer"},"referralCode":{"type":"string","description":"Referral Code"},"reportOnFileSince":{"type":["string","null"],"format":"date-time","description":"Date the report was first created at the credit bureau"},"dateOfBirth":{"type":["string","null"],"format":"date-time","description":"Date of Birth"},"deceasedDate":{"type":["string","null"],"format":"date-time","description":"Deceased Date"},"hitCode":{"type":"string","description":"Hit Code"},"hitCodeDescription":{"type":"string","description":"Hit Code Description"},"addressDiscrepancyIndicator":{"type":"string","description":"Identifies discrepancies in the addresses on file compared to addresses reported by lenders/creditors"},"fraudVictimAlert":{"type":"string","description":"Fraud Victim Alert Code"},"fraudVictimAlertDescription":{"type":"string","description":"Fraud Victim Alert Description"},"inquiriesWithin2Years":{"type":["integer","null"],"format":"int32","description":"Number of inquiries within the last 2 years"},"ofac":{"type":["integer","null"],"format":"int32","description":"Office of Foreign Assets Control indicator"},"ssnAffirm":{"type":"string","description":"SSN affirm Yes/No"},"identityScanAlert":{"type":"string","description":"Flags any potential discrepancies in the Consumer's identification"},"ecoaInquiryType":{"type":"string","description":"Equal Credit Opportunity Act inquiry type"},"frozenFile":{"type":["boolean","null"],"description":"Advises if the Consumer's credit file is frozen"},"lockAlert":{"type":["boolean","null"],"description":"Advises if the Consumer's credit file is locked"},"mlaStatus":{"type":"string","description":"Advises if the Consumer is covered under the military lending act"}}}},"components/schemas/CreditsafeGlobalDataReportsConsumerCsusSearchCriteria":{"id":"components/schemas/CreditsafeGlobalDataReportsConsumerCsusSearchCriteria","kind":"json-schema","title":"CreditsafeGlobalDataReportsConsumerCsusSearchCriteria","data":{"type":"object","properties":{"identifier":{"type":"string","description":"Identifier"},"nameIdentifier":{"type":"string","description":"Name identifier e.g. current etc."},"firstName":{"type":"string","description":"The First Name used in the search criteria"},"lastName":{"type":"string","description":"The Last Name used in the search criteria"},"dateOfBirth":{"type":["string","null"],"format":"date-time","description":"The Date of Birth used in the search criteria"},"socialSecurityNumber":{"type":"string","description":"The person number used in the search criteria"},"addressSource":{"type":"string","description":"Address Source"},"addressStatus":{"type":"string","description":"Address Status e.g. current, former etc."},"addressLine1":{"type":"string","description":"First line of the address used in the search criteria"},"city":{"type":"string","description":"The City used in the search criteria"},"state":{"type":"string","description":"The State used in the search criteria"},"zip":{"type":"string","description":"The Zip used in the search criteria"},"country":{"type":"string","description":"The Country the address is domiciled"}}}},"components/schemas/CreditsafeGlobalDataReportsConsumerCsusActiveAccountDetailsSummary":{"id":"components/schemas/CreditsafeGlobalDataReportsConsumerCsusActiveAccountDetailsSummary","kind":"json-schema","title":"CreditsafeGlobalDataReportsConsumerCsusActiveAccountDetailsSummary","data":{"type":"object","properties":{"accountType":{"type":"string","description":"Account types Revolving, Installment, Others and Totals"},"summary":{"type":"object","properties":{"accounts":{"type":"string","description":"Total number of accounts on file per account type"},"balance":{"type":"string","description":"Balance due on file per account type"},"creditAvailable":{"type":"string","description":"Total Credit Available per account type"},"pastDue":{"type":"string","description":"Total Number of days past due per account type"},"termsOfPayment":{"type":"string","description":"Total Terms of payment in month per account type"}}}}}},"components/schemas/CreditsafeGlobalDataReportsConsumerCsusTradeLine":{"id":"components/schemas/CreditsafeGlobalDataReportsConsumerCsusTradeLine","kind":"json-schema","title":"CreditsafeGlobalDataReportsConsumerCsusTradeLine","data":{"type":"object","properties":{"customerAccountNumber":{"type":"string","description":"The customer account number for the trade line"},"customerNumber":{"type":"string","description":"The customer number for the trade line"},"accountOwner":{"type":"string","description":"The account owner, name of the lender/creditor"},"customerName":{"type":"string","description":"The customer name"},"balance":{"type":"string","description":"Balance remaining on the trade line"},"pastDue":{"type":"string","description":"Number of payments past due on the trade line"},"thirtyDayCounter":{"type":"string","description":"Number of times the Consumer has been late on a payment by 30-59 days on the trade line"},"sixtyDayCounter":{"type":"string","description":"Number of times the Consumer has been late on a payment by 60-90 days on the trade line"},"ninetyDayCounter":{"type":"string","description":"Number of times the Consumer has been late on a payment by more than 90 days on the trade line"},"highCredit":{"type":"string","description":"The high credit for the trade line (often the credit limit)"},"accountType":{"type":"string","description":"The trade line's account type e.g. Revolving, Installment, Other etc."},"monthsReviewed":{"type":"string","description":"Number of months the trade line has been reviewed"},"statusCode":{"type":"string","description":"The status code of the trade line"},"status":{"type":"string","description":"The status of the trade line"},"dateOpened":{"type":["string","null"],"format":"date-time","description":"The date the trade line was first opened"},"dateReported":{"type":["string","null"],"format":"date-time","description":"The date the trade line was first reported"},"dateOfLastActivity":{"type":["string","null"],"format":"date-time","description":"The date the trade line was last updated"},"terms":{"type":"string","description":"Payment terms of the trade line"},"comments":{"type":"array","items":{"type":"string"},"description":"Additional comments relating to the trade line"}}}},"components/schemas/CreditsafeGlobalDataReportsConsumerCsusFormerName":{"id":"components/schemas/CreditsafeGlobalDataReportsConsumerCsusFormerName","kind":"json-schema","title":"CreditsafeGlobalDataReportsConsumerCsusFormerName","data":{"type":"object","properties":{"firstName":{"type":"string","description":"First name of the former reported name for the Consumer"},"middleName":{"type":"string","description":"Middle name of the former reported name for the Consumer"},"lastName":{"type":"string","description":"Last name of the former reported name for the Consumer"},"suffix":{"type":"string","description":"Suffix of the former reported name for the Consumer"}}}},"components/schemas/CreditsafeGlobalDataReportsConsumerCsusEmployment":{"id":"components/schemas/CreditsafeGlobalDataReportsConsumerCsusEmployment","kind":"json-schema","title":"CreditsafeGlobalDataReportsConsumerCsusEmployment","data":{"type":"object","properties":{"employmentStatus":{"type":"string","description":"The status of the reported employment e.g. Current, Former etc."},"employerName":{"type":"string","description":"The employer for the listed employment"},"occupation":{"type":"string","description":"The occupation or job title of the Consumer during the listed employment"}}}},"components/schemas/CreditsafeGlobalDataReportsConsumerCsusConsumerStatement":{"id":"components/schemas/CreditsafeGlobalDataReportsConsumerCsusConsumerStatement","kind":"json-schema","title":"CreditsafeGlobalDataReportsConsumerCsusConsumerStatement","data":{"type":"object","properties":{"dateReported":{"type":["string","null"],"format":"date-time","description":"The date the statement was reported"},"datePurged":{"type":["string","null"],"format":"date-time","description":"Date the statement was purged"},"statement":{"type":"string","description":"Free text containing the statement of the Consumer"}}}},"components/schemas/CreditsafeGlobalDataReportsConsumerCsusAlertContact":{"id":"components/schemas/CreditsafeGlobalDataReportsConsumerCsusAlertContact","kind":"json-schema","title":"CreditsafeGlobalDataReportsConsumerCsusAlertContact","data":{"type":"object","properties":{"alertType":{"type":"string","description":"The type of alert reported on the Consumer e.g. Extended Fraud, Initial Fraud etc."},"dateReported":{"type":["string","null"],"format":"date-time","description":"The date the alert was reported"},"dateEffective":{"type":["string","null"],"format":"date-time","description":"The date the alert was effective from"},"status":{"type":"string","description":"The status of the alert"},"address":{"type":"object","properties":{"street":{"type":"string","description":"Street of the listed address of the contact"},"city":{"type":"string","description":"City of the listed address of the contact"},"province":{"type":"string","description":"Province of the listed address of the contact"},"postalCode":{"type":"string","description":"Postal/Zip of the listed address of the contact"},"additionalInformation":{"type":"string","description":"Any additional data for the listed address of the contact"}}},"telephoneNumbers":{"type":"array","items":{"type":"object","properties":{"telephoneNumberType":{"type":"string","description":"The type of telephone number e.g. Cellular, Pager, Daytime etc."},"countryCode":{"type":"string","description":"The country code for the contact telephone number"},"telephoneNumber":{"type":"string","description":"The reported telephone number for the contact"},"extension":{"type":"string","description":"The extension of the contact"}}}}}}},"components/schemas/CreditsafeGlobalDataReportsConsumerCsusInquiry":{"id":"components/schemas/CreditsafeGlobalDataReportsConsumerCsusInquiry","kind":"json-schema","title":"CreditsafeGlobalDataReportsConsumerCsusInquiry","data":{"type":"object","properties":{"customerName":{"type":"string","description":"The name of the customer that initiated the inquiry"},"customerNumber":{"type":"string","description":"The designated ID of the customer that initiated the inquiry"},"dateOfInquiry":{"type":["string","null"],"format":"date-time","description":"The date the inquiry was carried out"},"foreignInquiry":{"type":["boolean","null"],"description":"Foreign inquiry indicator, true/false"}}}},"components/schemas/CreditsafeGlobalDataReportsConsumerCsusAdditionalInformation":{"id":"components/schemas/CreditsafeGlobalDataReportsConsumerCsusAdditionalInformation","kind":"json-schema","title":"CreditsafeGlobalDataReportsConsumerCsusAdditionalInformation","data":{"type":"object","properties":{"misc":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsConsumerCsusMisc"},"searchCriteria":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsConsumerCsusSearchCriteria"},"activeAccountDetailsSummary":{"type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsConsumerCsusActiveAccountDetailsSummary"}},"tradeLines":{"type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsConsumerCsusTradeLine"}},"formerNames":{"type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsConsumerCsusFormerName"}},"employments":{"type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsConsumerCsusEmployment"}},"consumerStatements":{"type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsConsumerCsusConsumerStatement"}},"alertContacts":{"type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsConsumerCsusAlertContact"}},"inquiries":{"type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsConsumerCsusInquiry"}}}}},"components/schemas/CreditsafeGlobalDataReportsConsumerCsusConsumerReport":{"id":"components/schemas/CreditsafeGlobalDataReportsConsumerCsusConsumerReport","kind":"json-schema","title":"CreditsafeGlobalDataReportsConsumerCsusConsumerReport","data":{"type":"object","description":"Consumer Report response","properties":{"language":{"type":"string","description":"Report language code"},"consumerInformation":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsConsumerCsusConsumerInformation"},"creditScoreExtra":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsConsumerCsusCreditScoreExtra"},"contactInformation":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsConsumerCsusContactInformation"},"negativeInformation":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsConsumerCsusNegativeInformation"},"additionalInformation":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsConsumerCsusAdditionalInformation"}}}},"components/schemas/CreditsafeGlobalDataReportsConsumerCsusTryReportResponse":{"id":"components/schemas/CreditsafeGlobalDataReportsConsumerCsusTryReportResponse","kind":"json-schema","title":"CreditsafeGlobalDataReportsConsumerCsusTryReportResponse","data":{"type":"object","properties":{"correlationId":{"type":"string"},"report":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsConsumerCsusConsumerReport"},"dateOfOrder":{"type":"string","format":"date-time"},"language":{"type":"string"},"userId":{"type":"string"}}}},"components/schemas/ConnectDataCleaningJob":{"id":"components/schemas/ConnectDataCleaningJob","kind":"json-schema","title":"ConnectDataCleaningJob","data":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the Data Cleaning job."},"name":{"type":"string","description":"Name of the Data Cleaning job."},"createdAt":{"type":"string","format":"date-time","description":"Date and time when the job was created."},"modifiedAt":{"type":"string","format":"date-time","description":"Date and time when the job was last modified."},"managingUserId":{"type":"integer","format":"int32","description":"User ID currently managing the job."},"managingCustomerId":{"type":"integer","format":"int32","description":"Customer ID currently managing the job."},"owningCustomerId":{"type":"integer","format":"int32","description":"Customer ID that owns the job."},"owningUserId":{"type":"integer","format":"int32","description":"User ID that owns the job."},"owningCompanyName":{"type":"string","description":"Company name that owns the job."},"status":{"type":"string","description":"Current status of the job.","example":"created","enum":["created","uploading","uploadError","uploaded","ready","matching","matchingError","matched","addingToPortfolio","addedToPortfolio","addedToPortfolioError","aggregating","aggregatingComplete","aggregatingError","enriching","enrichmentError","enriched","transformFileError","generateTrilliumFileError","jobMatchingCompletionError","jobMatchingComplete","readyForEnriching","enrichmentComplete","enrichmentCompletionError","pdfGenerationError"]},"countryCode":{"type":"string","description":"Country code associated with the job."},"portfolioId":{"type":"string","description":"Portfolio identifier associated with the job."},"source":{"type":"string","description":"Source system that created the job.","example":"dataCleaning","enum":["dataCleaning","prospects"]},"jobSummary":{"type":"object","description":"Row-level matching summary for the uploaded job data.","properties":{"totalRows":{"type":"integer","format":"int32","description":"Total number of rows processed."},"matched":{"type":"integer","format":"int32","description":"Number of rows matched automatically."},"manualMatched":{"type":"integer","format":"int32","description":"Number of rows matched manually."},"unmatched":{"type":"integer","format":"int32","description":"Number of rows not matched."},"duplicates":{"type":"integer","format":"int32","description":"Number of duplicate rows detected."}}},"jobEnrichmentSettings":{"type":"object","description":"Enrichment settings used for the job.","properties":{"headquarters":{"type":"string","description":"Headquarters enrichment setting."},"creditType":{"type":"string","description":"Credit enrichment type selected for the job."},"dE_Reason":{"type":"object","description":"Decision engine reason metadata.","properties":{"id":{"type":"integer","format":"int32","description":"Decision engine reason identifier."},"descripton":{"type":"string","description":"Decision engine reason description."}}},"algorithmBanding":{"type":"array","description":"Algorithm banding values selected for enrichment.","items":{"type":"string"}},"countries":{"type":"array","description":"Countries included in enrichment processing.","items":{"type":"string"}}}},"archived":{"type":"boolean","description":"Indicates whether the job is archived."},"owningUserAccountStatus":{"type":"string","description":"Account status of the owning user."}}}},"components/schemas/ArrayOfConnectDataCleaningJob":{"id":"components/schemas/ArrayOfConnectDataCleaningJob","kind":"json-schema","title":"ArrayOfConnectDataCleaningJob","data":{"type":"array","items":{"$ref":"#/components/schemas/ConnectDataCleaningJob"}}},"components/schemas/ConnectDataCleaningCreateJobRequest":{"id":"components/schemas/ConnectDataCleaningCreateJobRequest","kind":"json-schema","title":"ConnectDataCleaningCreateJobRequest","data":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"Name for the Data Cleaning job to create."},"owningCompanyName":{"type":"string","description":"Company name associated with the job owner."},"source":{"type":"string","default":"DataCleaning","description":"Source system creating the job. Defaults to DataCleaning when omitted."}}}},"components/schemas/ConnectDataCleaningArchiveJobRequest":{"id":"components/schemas/ConnectDataCleaningArchiveJobRequest","kind":"json-schema","title":"ConnectDataCleaningArchiveJobRequest","data":{"type":"object"}},"components/schemas/jobEnrichmentSettings":{"id":"components/schemas/jobEnrichmentSettings","kind":"json-schema","title":"jobEnrichmentSettings","data":{"type":"object","properties":{"creditType":{"type":"string"}}}},"components/schemas/ConnectDataCleaningArchiveResponse":{"id":"components/schemas/ConnectDataCleaningArchiveResponse","kind":"json-schema","title":"ConnectDataCleaningArchiveResponse","data":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"createdAt":{"type":"string"},"modifiedAt":{"type":"string","format":"date-time"},"managingUserId":{"type":"integer"},"managingCustomerId":{"type":"integer"},"owningCustomerId":{"type":"integer"},"owningUserId":{"type":"integer"},"status":{"type":"string"},"countryCode":{"type":"string"},"source":{"type":"string"},"jobEnrichmentSettings":{"$ref":"#/components/schemas/jobEnrichmentSettings"},"archived":{"type":"boolean"}}}},"components/schemas/ConnectDataCleaningEnrichRequest":{"id":"components/schemas/ConnectDataCleaningEnrichRequest","kind":"json-schema","title":"ConnectDataCleaningEnrichRequest","data":{"type":"object"}},"components/schemas/ConnectDataCleaningResponse":{"id":"components/schemas/ConnectDataCleaningResponse","kind":"json-schema","title":"ConnectDataCleaningResponse","data":{"type":"object"}},"components/schemas/ArrayOfConnectDataCleaningResponse":{"id":"components/schemas/ArrayOfConnectDataCleaningResponse","kind":"json-schema","title":"ArrayOfConnectDataCleaningResponse","data":{"type":"array","items":{"$ref":"#/components/schemas/ConnectDataCleaningResponse"}}},"components/schemas/basic":{"id":"components/schemas/basic","kind":"json-schema","title":"basic","data":{"type":"object","properties":{"enrichments":{"type":"array","items":{"type":"object","properties":{"enrichment":{"type":"string"}}}}},"example":{"enrichments":[{"enrichment":"general.safeNumber"},{"enrichment":"general.connectId"},{"enrichment":"general.ggsId"},{"enrichment":"general.companyName"},{"enrichment":"general.companyId"},{"enrichment":"general.companyNameKanji"},{"enrichment":"general.companyNameKana"},{"enrichment":"general.aliasName"},{"enrichment":"general.tradeName"},{"enrichment":"general.tradeNumber"},{"enrichment":"general.acronym"},{"enrichment":"general.organisationNumber"},{"enrichment":"general.legalRegistrationNumber"},{"enrichment":"general.siret"},{"enrichment":"general.siren"},{"enrichment":"general.companyNumber"},{"enrichment":"general.kvkNumber"},{"enrichment":"contact.eircode"},{"enrichment":"contact.country"},{"enrichment":"contact.mailing.city"},{"enrichment":"general.companyType"},{"enrichment":"general.companyTypeDesc.en"},{"enrichment":"general.legalName"},{"enrichment":"general.legalNameAlt"},{"enrichment":"general.rsin"},{"enrichment":"general.tradingName"},{"enrichment":"general.regDeletionNumber"},{"enrichment":"general.pattern"},{"enrichment":"general.banding"},{"enrichment":"general.bandingDesc"},{"enrichment":"general.rowNumber"},{"enrichment":"general.duplicate"},{"enrichment":"general.duplicateId"},{"enrichment":"contact.city"}]}}},"components/schemas/basicPlus":{"id":"components/schemas/basicPlus","kind":"json-schema","title":"basicPlus","data":{"type":"object","properties":{"enrichments":{"type":"array","items":{"type":"object","properties":{"enrichment":{"type":"string"}}}}},"example":{"enrichments":[{"enrichment":"general.safeNumber"},{"enrichment":"general.connectId"},{"enrichment":"general.ggsId"},{"enrichment":"general.companyName"},{"enrichment":"general.companyId"},{"enrichment":"general.companyNameKanji"},{"enrichment":"general.companyNameKana"},{"enrichment":"general.aliasName"},{"enrichment":"general.tradeName"},{"enrichment":"general.tradeNumber"},{"enrichment":"general.acronym"},{"enrichment":"general.organisationNumber"},{"enrichment":"general.legalRegistrationNumber"},{"enrichment":"general.siret"},{"enrichment":"general.siren"},{"enrichment":"general.companyNumber"},{"enrichment":"general.kvkNumber"},{"enrichment":"contact.eircode"},{"enrichment":"contact.country"},{"enrichment":"contact.mailing.city"},{"enrichment":"general.companyType"},{"enrichment":"general.companyTypeDesc.en"},{"enrichment":"general.legalName"},{"enrichment":"general.legalNameAlt"},{"enrichment":"general.rsin"},{"enrichment":"general.tradingName"},{"enrichment":"general.regDeletionNumber"},{"enrichment":"general.pattern"},{"enrichment":"general.banding"},{"enrichment":"general.bandingDesc"},{"enrichment":"general.rowNumber"},{"enrichment":"general.duplicate"},{"enrichment":"general.duplicateId"},{"enrichment":"contact.city"},{"enrichment":"general.taxCode"},{"enrichment":"general.vatNumber"},{"enrichment":"general.vatLiable"},{"enrichment":"general.principalActivity"},{"enrichment":"general.principalActivity2"},{"enrichment":"general.principalActivity3"},{"enrichment":"general.principalActivity4"},{"enrichment":"general.principalActivity5"},{"enrichment":"general.statusDesc.en"},{"enrichment":"contact.addressLine1"},{"enrichment":"contact.addressLine3"},{"enrichment":"contact.addressLine4"},{"enrichment":"contact.addressLine5"},{"enrichment":"contact.addressLine6"},{"enrichment":"contact.streetName"},{"enrichment":"contact.houseNumber"},{"enrichment":"contact.state"},{"enrichment":"contact.postBox"},{"enrichment":"contact.zip4"},{"enrichment":"contact.region"},{"enrichment":"contact.municipality"},{"enrichment":"contact.province"},{"enrichment":"contact.mailing.addressLine1"},{"enrichment":"contact.mailing.addressLine2"},{"enrichment":"contact.mailing.addressLine3"},{"enrichment":"contact.mailing.addressLine4"},{"enrichment":"contact.mailing.streetName"},{"enrichment":"contact.mailing.houseNumber"},{"enrichment":"contact.mailing.province"},{"enrichment":"contact.mailing.postalCode"},{"enrichment":"contact.nonMailingIndicator"},{"enrichment":"contact.officeAddress1"},{"enrichment":"contact.officeAddress2"},{"enrichment":"contact.officeAddress3"},{"enrichment":"contact.addressType"},{"enrichment":"contact.paf.addressLine1"},{"enrichment":"contact.paf.addressLine2"},{"enrichment":"contact.paf.addressLine3"},{"enrichment":"contact.paf.addressLine4"},{"enrichment":"contact.paf.postalCode"},{"enrichment":"general.locationType"},{"enrichment":"contact.contactPhone"},{"enrichment":"contact.tps"},{"enrichment":"contact.marketingAllowed"},{"enrichment":"contact.fax"},{"enrichment":"contact.specialDistribution"},{"enrichment":"contact.additionToAddress"},{"enrichment":"general.activityCode"},{"enrichment":"general.activityCodeDesc.en"},{"enrichment":"general.activityCodeDesc.jp"},{"enrichment":"general.activityCodeDesc.it"},{"enrichment":"general.activityCodeDesc.fr"},{"enrichment":"general.activityCodeDesc.se"},{"enrichment":"general.activityCodeDesc.de"},{"enrichment":"general.activityCode2"},{"enrichment":"general.activityCode2Desc.en"},{"enrichment":"general.activityCode2Desc.jp"},{"enrichment":"general.activityCode3"},{"enrichment":"general.activityCode3Desc.en"},{"enrichment":"general.sectorCode"},{"enrichment":"general.legalForm"},{"enrichment":"general.legalFormCategory"},{"enrichment":"general.legalFormDetails"},{"enrichment":"general.legalFormDesc.en"},{"enrichment":"general.legalFormDesc.it"},{"enrichment":"general.legalFormDesc.nl"},{"enrichment":"general.legalFormDesc.fr"},{"enrichment":"general.legalFormDesc.de"},{"enrichment":"general.legalFormDesc.no"},{"enrichment":"general.naicsCode"},{"enrichment":"general.naicsCodeDesc.en"},{"enrichment":"general.website"},{"enrichment":"contact.email"},{"enrichment":"general.establishDate"},{"enrichment":"general.registrationDate"},{"enrichment":"general.registrationLocation"},{"enrichment":"general.employees"},{"enrichment":"general.workforceCode"},{"enrichment":"general.workforceCodeDesc.en"},{"enrichment":"general.workforceCodeDesc.fr"},{"enrichment":"general.minimalWorkforceRange"},{"enrichment":"general.annualSales"},{"enrichment":"general.juridicalForm"},{"enrichment":"general.juridicalFormDesc.en"},{"enrichment":"general.juridicalFormDesc.fr"},{"enrichment":"general.juridicalFormDesc.nl"},{"enrichment":"general.status"},{"enrichment":"general.statusDesc.fr"},{"enrichment":"general.statusDesc.nl"},{"enrichment":"general.statusDescShort.en"},{"enrichment":"general.statusDescShort.fr"},{"enrichment":"general.active"},{"enrichment":"financials.shareCapital"},{"enrichment":"financials.bankName"},{"enrichment":"financials.shareCapitalCurrency"},{"enrichment":"financials.bankCode"},{"enrichment":"general.sosFederalTaxId"},{"enrichment":"general.sosCharterNo"},{"enrichment":"general.sosStatus"},{"enrichment":"general.incorporatedState"},{"enrichment":"general.sosAddress"},{"enrichment":"general.sosCity"},{"enrichment":"general.sosState"},{"enrichment":"general.sosZip"},{"enrichment":"general.sosZip4"},{"enrichment":"general.incorporationDate"},{"enrichment":"group.parent.siret"},{"enrichment":"group.parent.siren"},{"enrichment":"group.ultimateParent.siren"},{"enrichment":"general.importFlag"},{"enrichment":"general.exportFlag"},{"enrichment":"general.ltdNonLtdFlag"},{"enrichment":"general.priority"},{"enrichment":"general.activityCodeDesc.nl"},{"enrichment":"general.mainOfficeFlag"},{"enrichment":"general.yearsTrading"},{"enrichment":"general.foundingDeedDate"},{"enrichment":"general.continuanceDate"},{"enrichment":"general.discontinuanceDate"},{"enrichment":"general.mortgages.partiallySatisfied"},{"enrichment":"general.mortgages.satisfied"},{"enrichment":"general.mortgages.outstanding"},{"enrichment":"general.mortgages.total"},{"enrichment":"general.managerType"},{"enrichment":"general.managerTypeDesc.en"},{"enrichment":"general.managerTypeDesc.fr"},{"enrichment":"financials.consolidationCode"},{"enrichment":"contact.addressLine2"},{"enrichment":"contact.postalCode"}]}}},"components/schemas/standard":{"id":"components/schemas/standard","kind":"json-schema","title":"standard","data":{"type":"object","properties":{"enrichments":{"type":"array","items":{"type":"object","properties":{"enrichment":{"type":"string"}}}}},"example":{"enrichments":[{"enrichment":"general.safeNumber"},{"enrichment":"general.connectId"},{"enrichment":"general.ggsId"},{"enrichment":"general.companyName"},{"enrichment":"general.companyId"},{"enrichment":"general.companyNameKanji"},{"enrichment":"general.companyNameKana"},{"enrichment":"general.aliasName"},{"enrichment":"general.tradeName"},{"enrichment":"general.tradeNumber"},{"enrichment":"general.acronym"},{"enrichment":"general.organisationNumber"},{"enrichment":"general.legalRegistrationNumber"},{"enrichment":"general.siret"},{"enrichment":"general.siren"},{"enrichment":"general.companyNumber"},{"enrichment":"general.kvkNumber"},{"enrichment":"contact.eircode"},{"enrichment":"contact.country"},{"enrichment":"contact.mailing.city"},{"enrichment":"general.companyType"},{"enrichment":"general.companyTypeDesc.en"},{"enrichment":"general.legalName"},{"enrichment":"general.legalNameAlt"},{"enrichment":"general.rsin"},{"enrichment":"general.tradingName"},{"enrichment":"general.regDeletionNumber"},{"enrichment":"general.pattern"},{"enrichment":"general.banding"},{"enrichment":"general.bandingDesc"},{"enrichment":"general.rowNumber"},{"enrichment":"general.duplicate"},{"enrichment":"general.duplicateId"},{"enrichment":"contact.city"},{"enrichment":"general.taxCode"},{"enrichment":"general.vatNumber"},{"enrichment":"general.vatLiable"},{"enrichment":"general.principalActivity"},{"enrichment":"general.principalActivity2"},{"enrichment":"general.principalActivity3"},{"enrichment":"general.principalActivity4"},{"enrichment":"general.principalActivity5"},{"enrichment":"general.statusDesc.en"},{"enrichment":"contact.addressLine1"},{"enrichment":"contact.addressLine3"},{"enrichment":"contact.addressLine4"},{"enrichment":"contact.addressLine5"},{"enrichment":"contact.addressLine6"},{"enrichment":"contact.streetName"},{"enrichment":"contact.houseNumber"},{"enrichment":"contact.state"},{"enrichment":"contact.postBox"},{"enrichment":"contact.zip4"},{"enrichment":"contact.region"},{"enrichment":"contact.municipality"},{"enrichment":"contact.province"},{"enrichment":"contact.mailing.addressLine1"},{"enrichment":"contact.mailing.addressLine2"},{"enrichment":"contact.mailing.addressLine3"},{"enrichment":"contact.mailing.addressLine4"},{"enrichment":"contact.mailing.streetName"},{"enrichment":"contact.mailing.houseNumber"},{"enrichment":"contact.mailing.province"},{"enrichment":"contact.mailing.postalCode"},{"enrichment":"contact.nonMailingIndicator"},{"enrichment":"contact.officeAddress1"},{"enrichment":"contact.officeAddress2"},{"enrichment":"contact.officeAddress3"},{"enrichment":"contact.addressType"},{"enrichment":"contact.paf.addressLine1"},{"enrichment":"contact.paf.addressLine2"},{"enrichment":"contact.paf.addressLine3"},{"enrichment":"contact.paf.addressLine4"},{"enrichment":"contact.paf.postalCode"},{"enrichment":"general.locationType"},{"enrichment":"contact.contactPhone"},{"enrichment":"contact.tps"},{"enrichment":"contact.marketingAllowed"},{"enrichment":"contact.fax"},{"enrichment":"contact.specialDistribution"},{"enrichment":"contact.additionToAddress"},{"enrichment":"general.activityCode"},{"enrichment":"general.activityCodeDesc.en"},{"enrichment":"general.activityCodeDesc.jp"},{"enrichment":"general.activityCodeDesc.it"},{"enrichment":"general.activityCodeDesc.fr"},{"enrichment":"general.activityCodeDesc.se"},{"enrichment":"general.activityCodeDesc.de"},{"enrichment":"general.activityCode2"},{"enrichment":"general.activityCode2Desc.en"},{"enrichment":"general.activityCode2Desc.jp"},{"enrichment":"general.activityCode3"},{"enrichment":"general.activityCode3Desc.en"},{"enrichment":"general.sectorCode"},{"enrichment":"general.legalForm"},{"enrichment":"general.legalFormCategory"},{"enrichment":"general.legalFormDetails"},{"enrichment":"general.legalFormDesc.en"},{"enrichment":"general.legalFormDesc.it"},{"enrichment":"general.legalFormDesc.nl"},{"enrichment":"general.legalFormDesc.fr"},{"enrichment":"general.legalFormDesc.de"},{"enrichment":"general.legalFormDesc.no"},{"enrichment":"general.naicsCode"},{"enrichment":"general.naicsCodeDesc.en"},{"enrichment":"general.website"},{"enrichment":"contact.email"},{"enrichment":"general.establishDate"},{"enrichment":"general.registrationDate"},{"enrichment":"general.registrationLocation"},{"enrichment":"general.employees"},{"enrichment":"general.workforceCode"},{"enrichment":"general.workforceCodeDesc.en"},{"enrichment":"general.workforceCodeDesc.fr"},{"enrichment":"general.minimalWorkforceRange"},{"enrichment":"general.annualSales"},{"enrichment":"general.juridicalForm"},{"enrichment":"general.juridicalFormDesc.en"},{"enrichment":"general.juridicalFormDesc.fr"},{"enrichment":"general.juridicalFormDesc.nl"},{"enrichment":"general.status"},{"enrichment":"general.statusDesc.fr"},{"enrichment":"general.statusDesc.nl"},{"enrichment":"general.statusDescShort.en"},{"enrichment":"general.statusDescShort.fr"},{"enrichment":"general.active"},{"enrichment":"financials.shareCapital"},{"enrichment":"financials.bankName"},{"enrichment":"financials.shareCapitalCurrency"},{"enrichment":"financials.bankCode"},{"enrichment":"general.sosFederalTaxId"},{"enrichment":"general.sosCharterNo"},{"enrichment":"general.sosStatus"},{"enrichment":"general.incorporatedState"},{"enrichment":"general.sosAddress"},{"enrichment":"general.sosCity"},{"enrichment":"general.sosState"},{"enrichment":"general.sosZip"},{"enrichment":"general.sosZip4"},{"enrichment":"general.incorporationDate"},{"enrichment":"group.parent.siret"},{"enrichment":"group.parent.siren"},{"enrichment":"group.ultimateParent.siren"},{"enrichment":"general.importFlag"},{"enrichment":"general.exportFlag"},{"enrichment":"general.ltdNonLtdFlag"},{"enrichment":"general.priority"},{"enrichment":"general.activityCodeDesc.nl"},{"enrichment":"general.mainOfficeFlag"},{"enrichment":"general.yearsTrading"},{"enrichment":"general.foundingDeedDate"},{"enrichment":"general.continuanceDate"},{"enrichment":"general.discontinuanceDate"},{"enrichment":"general.mortgages.partiallySatisfied"},{"enrichment":"general.mortgages.satisfied"},{"enrichment":"general.mortgages.outstanding"},{"enrichment":"general.mortgages.total"},{"enrichment":"general.managerType"},{"enrichment":"general.managerTypeDesc.en"},{"enrichment":"general.managerTypeDesc.fr"},{"enrichment":"financials.consolidationCode"},{"enrichment":"contact.addressLine2"},{"enrichment":"contact.postalCode"},{"enrichment":"general.federalTaxId"},{"enrichment":"general.inactivityDate"},{"enrichment":"negatives.legalFilings"},{"enrichment":"negatives.uccCount"},{"enrichment":"negatives.lienCount"},{"enrichment":"negatives.lienAmount"},{"enrichment":"negatives.lienDate"},{"enrichment":"negatives.suitCount"},{"enrichment":"negatives.suitAmount"},{"enrichment":"negatives.suitDate"},{"enrichment":"negatives.bankruptcyCount"},{"enrichment":"negatives.bankruptcyAmount"},{"enrichment":"negatives.bankruptcyDate"},{"enrichment":"negatives.judgementCount"},{"enrichment":"negatives.judgementAmount"},{"enrichment":"negatives.judgementDate"},{"enrichment":"negatives.chequeCount"},{"enrichment":"negatives.chequeAmount"},{"enrichment":"negatives.chequeDate"},{"enrichment":"negatives.otherItemCount"},{"enrichment":"negatives.otherItemAmount"},{"enrichment":"negatives.otherItemDate"},{"enrichment":"negatives.uccCautionaryCount"},{"enrichment":"negatives.legalFilingsAmount"},{"enrichment":"negatives.ofacFlag"},{"enrichment":"negatives.ccjCount"},{"enrichment":"negatives.ccjValue"},{"enrichment":"financials.pretaxNetOperatingIncome"},{"enrichment":"financials.extraordinaryIncome"},{"enrichment":"financials.extraordinaryCharges"},{"enrichment":"financials.extraordinaryProfitLoss"},{"enrichment":"financials.tradingMargin"},{"enrichment":"financials.addedValue"},{"enrichment":"financials.grossOperatingSurplus"},{"enrichment":"financials.balance.period1Late"},{"enrichment":"financials.balance.period2Late"},{"enrichment":"financials.balance.period3Late"},{"enrichment":"financials.lastUpdateDate"},{"enrichment":"financials.closureDate"},{"enrichment":"financials.accountPeriodInMonths"},{"enrichment":"financials.capitalNotCalled"},{"enrichment":"financials.financialAssets"},{"enrichment":"financialsNonConsolidated.financialAssets"},{"enrichment":"financials.netCurrentAssets"},{"enrichment":"financials.advancedPayments"},{"enrichment":"financials.receivables"},{"enrichment":"financials.securitiesAndCash"},{"enrichment":"financials.prepaidExpenses"},{"enrichment":"financialsNonConsolidated.prepaidExpenses"},{"enrichment":"financials.shareholdersEquity"},{"enrichment":"financials.otherCapitalResources"},{"enrichment":"financials.riskProvisions"},{"enrichment":"financials.liabilities"},{"enrichment":"financialsNonConsolidated.liabilities"},{"enrichment":"financials.financialLiabilities"},{"enrichment":"financials.advancedPaymentsReceived"},{"enrichment":"financials.tradeAccountPayables"},{"enrichment":"financials.taxAndSocialLiabilities"},{"enrichment":"financials.currency"},{"enrichment":"financialsNonConsolidated.currency"},{"enrichment":"financials.otherDebtsAndFixedAssets"},{"enrichment":"financials.accountsRegularisation"},{"enrichment":"financials.salesOfGoods"},{"enrichment":"financials.netTurnover"},{"enrichment":"financials.netExportTurnover"},{"enrichment":"financials.operatingCharges"},{"enrichment":"financials.financialProfit"},{"enrichment":"financials.accountsOfRegularisation"},{"enrichment":"rating.current.date"},{"enrichment":"rating.current.score"},{"enrichment":"rating.current.description.en"},{"enrichment":"rating.current.description.nl"},{"enrichment":"rating.current.description.no"},{"enrichment":"rating.current.description.fr"},{"enrichment":"rating.current.description.jp"},{"enrichment":"rating.current.fullDescription.en"},{"enrichment":"rating.current.fullDescription.no"},{"enrichment":"rating.current.local"},{"enrichment":"rating.current.creditIndex"},{"enrichment":"rating.current.cds"},{"enrichment":"rating.current.pod"},{"enrichment":"limit.current.value"},{"enrichment":"limit.current.date"},{"enrichment":"rating.current.common"},{"enrichment":"rating.current.colour"},{"enrichment":"rating.previous.score"},{"enrichment":"rating.previous.description.en"},{"enrichment":"rating.previous.description.no"},{"enrichment":"rating.previous.fullDescription.en"},{"enrichment":"rating.previous.fullDescription.no"},{"enrichment":"rating.previous.date"},{"enrichment":"limit.previous.value"},{"enrichment":"limit.previous.date"},{"enrichment":"rating.previous.common"},{"enrichment":"rating.creditworthy"},{"enrichment":"financials.plAccountReserve"},{"enrichment":"financials.otherShortTermFinance"},{"enrichment":"financials.retainedProfit"},{"enrichment":"financials.reserves"},{"enrichment":"financials.debtorDays"},{"enrichment":"financials.bankOverdraftLtl"},{"enrichment":"financials.otherCurrentDebtors"},{"enrichment":"financials.paidShareCapital"},{"enrichment":"financials.preTaxProfitMargin"},{"enrichment":"financials.auditComments"},{"enrichment":"financials.bankers"},{"enrichment":"financials.bankBranchCode"},{"enrichment":"financials.dbt.current"},{"enrichment":"financials.dbt.previous"},{"enrichment":"financials.dbt.local"},{"enrichment":"financials.amortizationAndDepreciation"},{"enrichment":"financials.directorRemuneration"},{"enrichment":"financials.dividends"},{"enrichment":"financials.employeeCosts"},{"enrichment":"financials.employeePensionCosts"},{"enrichment":"financials.equityInPercentage"},{"enrichment":"financials.extraordinaryItems"},{"enrichment":"financials.financialCharges"},{"enrichment":"financials.financialFixedAssets"},{"enrichment":"financials.financialIncome"},{"enrichment":"financials.finishedGoods"},{"enrichment":"financials.intangibleFixedAssets"},{"enrichment":"financials.inventories"},{"enrichment":"financials.issuedShareCapital"},{"enrichment":"financials.landAndBuilding"},{"enrichment":"financials.operatingIncome"},{"enrichment":"financials.otherAmountsReceivable"},{"enrichment":"financials.otherEmployeeCosts"},{"enrichment":"financials.otherStocks"},{"enrichment":"financials.turnover"},{"enrichment":"financials.otherTangibleAssets"},{"enrichment":"financials.otherTermLiabilities"},{"enrichment":"financials.otherTermLoans"},{"enrichment":"financials.plantAndMachinery"},{"enrichment":"financials.preProfitMargin"},{"enrichment":"financials.profitBeforeTax"},{"enrichment":"financials.rawAndConsumables"},{"enrichment":"financials.resultsAfterTaxation"},{"enrichment":"financials.salesWorkingCapital"},{"enrichment":"financials.sharePremiumAccount"},{"enrichment":"financials.socialSecurityContributions"},{"enrichment":"financials.tangibleFixedAssets"},{"enrichment":"financials.totalOperatingExpenses"},{"enrichment":"financials.totalTermDebts"},{"enrichment":"financials.workInProgress"},{"enrichment":"financials.accountingDate"},{"enrichment":"financialsNonConsolidated.accountingDate"},{"enrichment":"financials.numberOfWeeks"},{"enrichment":"financialsNonConsolidated.numberOfWeeks"},{"enrichment":"financials.assets"},{"enrichment":"financialsNonConsolidated.assets"},{"enrichment":"financials.tradeUpdateDate"},{"enrichment":"financials.tradelines"},{"enrichment":"financials.fixedAssets"},{"enrichment":"financialsNonConsolidated.fixedAssets"},{"enrichment":"financials.currentAssets"},{"enrichment":"financialsNonConsolidated.currentAssets"},{"enrichment":"financials.inventory"},{"enrichment":"financialsNonConsolidated.inventory"},{"enrichment":"financials.receivablesAndOther"},{"enrichment":"financialsNonConsolidated.receivablesAndOther"},{"enrichment":"financials.therefromTradeReceivables"},{"enrichment":"financialsNonConsolidated.therefromTradeReceivables"},{"enrichment":"financials.securities"},{"enrichment":"financialsNonConsolidated.securities"},{"enrichment":"financials.liquidAssets"},{"enrichment":"financialsNonConsolidated.liquidAssets"},{"enrichment":"financials.deferedTax"},{"enrichment":"financialsNonConsolidated.deferedTax"},{"enrichment":"financials.activeDiffBetweenAssetAllocation"},{"enrichment":"financialsNonConsolidated.activeDiffBetweenAssetAllocation"},{"enrichment":"financials.deficitNcbCapital"},{"enrichment":"financialsNonConsolidated.deficitNcbCapital"},{"enrichment":"financials.deficitNcblLossCapital"},{"enrichment":"financialsNonConsolidated.deficitNcblLossCapital"},{"enrichment":"financials.balanceSheetTotalAssets"},{"enrichment":"financialsNonConsolidated.balanceSheetTotalAssets"},{"enrichment":"financials.equity"},{"enrichment":"financialsNonConsolidated.equity"},{"enrichment":"financials.subscribedCapital"},{"enrichment":"financialsNonConsolidated.subscribedCapital"},{"enrichment":"financials.privateAccount"},{"enrichment":"financialsNonConsolidated.privateAccount"},{"enrichment":"financials.sharesNcblUnlimitedPartners"},{"enrichment":"financialsNonConsolidated.sharesNcblUnlimitedPartners"},{"enrichment":"financials.sharesNcblLimitedPartners"},{"enrichment":"financialsNonConsolidated.sharesNcblLimitedPartners"},{"enrichment":"financials.fixedEquity"},{"enrichment":"financialsNonConsolidated.fixedEquity"},{"enrichment":"financials.variableEquity"},{"enrichment":"financialsNonConsolidated.variableEquity"},{"enrichment":"financials.balance.current"},{"enrichment":"financials.balance.1to30"},{"enrichment":"financials.balance.31to60"},{"enrichment":"financials.balance.61to90"},{"enrichment":"financials.balance.91plus"},{"enrichment":"financials.balance.total"},{"enrichment":"financials.capitalReserve"},{"enrichment":"financialsNonConsolidated.capitalReserve"},{"enrichment":"financials.revenueReserve"},{"enrichment":"financialsNonConsolidated.revenueReserve"},{"enrichment":"financials.retainedEarnings"},{"enrichment":"financialsNonConsolidated.retainedEarnings"},{"enrichment":"financials.balanceSheetNetIncome"},{"enrichment":"financialsNonConsolidated.balanceSheetNetIncome"},{"enrichment":"financials.accruals"},{"enrichment":"financialsNonConsolidated.accruals"},{"enrichment":"financials.therefromAccrualsPension"},{"enrichment":"financialsNonConsolidated.therefromAccrualsPension"},{"enrichment":"financials.therefromAccrualsTax"},{"enrichment":"financialsNonConsolidated.therefromAccrualsTax"},{"enrichment":"financials.therefromTradePayables"},{"enrichment":"financialsNonConsolidated.therefromTradePayables"},{"enrichment":"financials.defferedIncome"},{"enrichment":"financialsNonConsolidated.defferedIncome"},{"enrichment":"financials.defferedLiabilities"},{"enrichment":"financialsNonConsolidated.defferedLiabilities"},{"enrichment":"financials.balanceSheetTotal"},{"enrichment":"financialsNonConsolidated.balanceSheetTotal"},{"enrichment":"financials.inventoryChange"},{"enrichment":"financialsNonConsolidated.inventoryChange"},{"enrichment":"financials.ownWork"},{"enrichment":"financialsNonConsolidated.ownWork"},{"enrichment":"financials.otherOperationalRevenue"},{"enrichment":"financialsNonConsolidated.otherOperationalRevenue"},{"enrichment":"financials.materials"},{"enrichment":"financialsNonConsolidated.materials"},{"enrichment":"financials.staff"},{"enrichment":"financialsNonConsolidated.staff"},{"enrichment":"financials.amortisation"},{"enrichment":"financialsNonConsolidated.amortisation"},{"enrichment":"financials.otherCosts"},{"enrichment":"financialsNonConsolidated.otherCosts"},{"enrichment":"financials.profitLoss"},{"enrichment":"financialsNonConsolidated.profitLoss"},{"enrichment":"financials.profit"},{"enrichment":"financials.operationalResult"},{"enrichment":"financialsNonConsolidated.operationalResult"},{"enrichment":"financials.therefromOtherInterestSimilarIncome"},{"enrichment":"financialsNonConsolidated.therefromOtherInterestSimilarIncome"},{"enrichment":"financials.therefromInterestsSimilarExpenses"},{"enrichment":"financialsNonConsolidated.therefromInterestsSimilarExpenses"},{"enrichment":"financials.financialResult"},{"enrichment":"financialsNonConsolidated.financialResult"},{"enrichment":"financials.ordinaryOperationalResult"},{"enrichment":"financialsNonConsolidated.ordinaryOperationalResult"},{"enrichment":"financials.extraordinaryResult"},{"enrichment":"financialsNonConsolidated.extraordinaryResult"},{"enrichment":"financials.tax"},{"enrichment":"financialsNonConsolidated.tax"},{"enrichment":"financials.otherTaxes"},{"enrichment":"financialsNonConsolidated.otherTaxes"},{"enrichment":"financials.netIncome"},{"enrichment":"financialsNonConsolidated.netIncome"},{"enrichment":"financials.yearOfBalance"},{"enrichment":"financials.totalShareholdersEquity"},{"enrichment":"financials.totalOperatingIncome"},{"enrichment":"financials.salesRevenue"},{"enrichment":"financials.otherOperatingIncome"},{"enrichment":"financials.costOfStocks"},{"enrichment":"financials.changeInStock"},{"enrichment":"financials.changeInWorkInProgress"},{"enrichment":"financials.writeDownOfFixedAssets"},{"enrichment":"financials.otherOperatingExpenses"},{"enrichment":"financials.allocatedDividend"},{"enrichment":"financials.revenueSubsidiaries"},{"enrichment":"financials.revenueGroupCompanies"},{"enrichment":"financials.revenueAssociatedCompanies"},{"enrichment":"financials.interestIncomeGroup"},{"enrichment":"financials.otherInterestIncome"},{"enrichment":"financials.otherFinancialIncome"},{"enrichment":"financials.changeValueCurrentAssets"},{"enrichment":"financials.writedownsCurrentAssets"},{"enrichment":"financials.writedownsFixedAssets"},{"enrichment":"financials.otherInterestExpensesGroup"},{"enrichment":"financials.otherInterestExpenses"},{"enrichment":"financials.otherFinancialExpenses"},{"enrichment":"financials.otherFinancialCosts"},{"enrichment":"financials.financialExpenses"},{"enrichment":"financials.totalNetFinancialItems"},{"enrichment":"financials.netProfitLoss"},{"enrichment":"financials.taxOnExtraordinaryResult"},{"enrichment":"financials.minorityShare"},{"enrichment":"financials.netResultAfterDividends"},{"enrichment":"financials.groupContributions"},{"enrichment":"financials.allocationOtherEquity"},{"enrichment":"financials.totalTransfersAllocations"},{"enrichment":"financials.researchAndDevelopment"},{"enrichment":"financials.concessions"},{"enrichment":"financials.deferredTaxAsset"},{"enrichment":"financials.goodwillIntangibleAssets"},{"enrichment":"financials.otherIntangibleFixedAssets"},{"enrichment":"financials.landAndBuildings"},{"enrichment":"financials.shipsRigsAircraft"},{"enrichment":"financials.operatingEquipment"},{"enrichment":"financials.otherOperationFactors"},{"enrichment":"financials.totalTangibleAssets"},{"enrichment":"financials.sharesInvestmentSubsidiaries"},{"enrichment":"financials.investmentsInGroupCompanies"},{"enrichment":"financials.investmentsInAssociatedCompanies"},{"enrichment":"financials.investmentsInShares"},{"enrichment":"financials.bondsAndAccountsReceivables"},{"enrichment":"financials.pensionFunds"},{"enrichment":"financials.otherFinancialFixedAssets"},{"enrichment":"financials.bonds"},{"enrichment":"financials.otherReceivables"},{"enrichment":"financials.otherReceivables2"},{"enrichment":"financials.otherFixedAssets"},{"enrichment":"financials.rawMaterials"},{"enrichment":"financials.otherInventories"},{"enrichment":"financials.totalInventories"},{"enrichment":"financials.tradeReceivables"},{"enrichment":"financials.receivablesToCompInGroup"},{"enrichment":"financials.totalReceivable"},{"enrichment":"financials.sharesAndInterestsInGroup"},{"enrichment":"financials.quotedInvestmentShares"},{"enrichment":"financials.quotedBonds"},{"enrichment":"financials.otherMarkedBasedFinancial"},{"enrichment":"financials.otherFinancialInstr"},{"enrichment":"financials.otherInvestments"},{"enrichment":"financials.cashAndBankDeposits"},{"enrichment":"financials.totalFunds"},{"enrichment":"financials.ownShares"},{"enrichment":"financials.sharePremiumReserve"},{"enrichment":"financials.otherPaidInCapital"},{"enrichment":"financials.totalEquityDeposits"},{"enrichment":"financials.valuationReserve"},{"enrichment":"financials.otherEquity"},{"enrichment":"financials.minorityInterestsGroups"},{"enrichment":"financials.totalRetainedEarnings"},{"enrichment":"financials.otherReserves"},{"enrichment":"financials.longtermPensionCommitments"},{"enrichment":"financials.deferredTaxLiabilities"},{"enrichment":"financials.otherProvisions"},{"enrichment":"financials.totalProvisionsLiabilities"},{"enrichment":"financials.convertibleLoans"},{"enrichment":"financials.otherLongtermLoans"},{"enrichment":"financials.longtermLiabilitiesFinInst"},{"enrichment":"financials.longtermGroupContrLiabilities"},{"enrichment":"financials.liableLoanCapital"},{"enrichment":"financials.otherLongtermLiabilities"},{"enrichment":"financials.totalOtherLongtermLiabilities"},{"enrichment":"financials.convertibleLoan"},{"enrichment":"financials.certificateLoan"},{"enrichment":"financials.shorttermLiabilitiesFinInst"},{"enrichment":"financials.payableTax"},{"enrichment":"financials.specialGovernmentTaxes"},{"enrichment":"financials.suggestedDividend"},{"enrichment":"financials.shorttermLiabilitiesGroup"},{"enrichment":"financials.otherCreditors"},{"enrichment":"financials.totalLiabilitiesEquity"},{"enrichment":"financials.solvencyRatio"},{"enrichment":"financials.recentHighCredit"},{"enrichment":"financials.operatingProfit"},{"enrichment":"financials.depreciation"},{"enrichment":"financials.auditFees"},{"enrichment":"financials.currentRatio"},{"enrichment":"financials.netWorkingCapital"},{"enrichment":"financials.gearingRatio"},{"enrichment":"financials.creditorDays"},{"enrichment":"financials.liquidityAcidTest"},{"enrichment":"financials.returnOnCapitalEmployed"},{"enrichment":"financials.returnOnTotalAssetsEmployed"},{"enrichment":"financials.currentDebtRatio"},{"enrichment":"financials.totalDebtRatio"},{"enrichment":"financials.stockTurnoverRatio"},{"enrichment":"financials.returnOnNetAssetsEmployed"},{"enrichment":"financials.netCashflowFromOperations"},{"enrichment":"financials.netCashflowBeforeFinancing"},{"enrichment":"financials.netCashflowFromFinancing"},{"enrichment":"financials.auditorsQualification"},{"enrichment":"financials.auditors"},{"enrichment":"financials.capitalEmployed"},{"enrichment":"financials.contingentLiability"},{"enrichment":"financials.latestAccountDate"},{"enrichment":"financials.profitLossAccount"},{"enrichment":"financials.paidUpCapital"},{"enrichment":"financials.accountsType"},{"enrichment":"financials.accountsFrom"},{"enrichment":"financials.accountsTo"},{"enrichment":"financials.accountsMonths"},{"enrichment":"financials.preTaxMargin"},{"enrichment":"financials.retainedProfits"},{"enrichment":"financials.dividendsPayable"},{"enrichment":"financials.profitAfterTax"},{"enrichment":"financials.taxation"},{"enrichment":"financials.preTaxProfit"},{"enrichment":"financials.interestPayments"},{"enrichment":"financials.consolidatedAccounts"},{"enrichment":"financials.exports"},{"enrichment":"financials.costOfSales"},{"enrichment":"financials.grossProfit"},{"enrichment":"financialsNonConsolidated.grossProfit"},{"enrichment":"financials.wagesSalaries"},{"enrichment":"financials.directorsEmoluments"},{"enrichment":"negatives.totalCollectionAmount"},{"enrichment":"negatives.bankruptcy"},{"enrichment":"negatives.delinquencyCount"},{"enrichment":"negatives.delinquencyAmount"},{"enrichment":"negatives.collectionCases"},{"enrichment":"negatives.collectionCount"},{"enrichment":"negatives.collectionAmount"},{"enrichment":"negatives.collectionDate"},{"enrichment":"financials.netAssets"},{"enrichment":"financials.totalLiabilities"},{"enrichment":"financials.totalLongTermLiabilities"},{"enrichment":"financials.otherLongTermFinance"},{"enrichment":"financials.miscCurrentLiabilities"},{"enrichment":"financials.otherShortTermFinancials"},{"enrichment":"financials.bankOverdraft"},{"enrichment":"financials.totalAssets"},{"enrichment":"financials.miscCurrentAssets"},{"enrichment":"financials.otherCurrentAssets"},{"enrichment":"financials.tradeDebtors"},{"enrichment":"financials.intangibleAssets"},{"enrichment":"financialsNonConsolidated.intangibleAssets"},{"enrichment":"financials.tangibleAssets"},{"enrichment":"financials.stocks"},{"enrichment":"financials.cash"},{"enrichment":"financials.shareholderFunds"},{"enrichment":"financials.revaluationReserve"},{"enrichment":"financials.sundryReserves"},{"enrichment":"financials.coefficientLinear"},{"enrichment":"financials.workingCapital"},{"enrichment":"financials.accountsStartDate"},{"enrichment":"financials.accountsEndDate"},{"enrichment":"financials.totalFixedAssets"},{"enrichment":"financials.totalCurrentAssets"},{"enrichment":"financials.tradeCreditors"},{"enrichment":"financials.totalCurrentLiabilities"},{"enrichment":"financials.longTermLiabilities"},{"enrichment":"financials.totalEquity"},{"enrichment":"financials.netWorth"},{"enrichment":"financials.liquidityRatio"},{"enrichment":"financials.netResult"},{"enrichment":"financials.capital"},{"enrichment":"financials.nominalCapital"},{"enrichment":"financials.placedCapital"},{"enrichment":"financials.depositedCapital"},{"enrichment":"group.daughter.name"},{"enrichment":"group.daughter.country"},{"enrichment":"group.parent.id"},{"enrichment":"group.parent.safeNumber"},{"enrichment":"group.parent.name"},{"enrichment":"group.parent.companyNo"},{"enrichment":"group.parent.rating.current.score"},{"enrichment":"group.parent.rating.current.description.en"},{"enrichment":"group.parent.rating.current.description.nl"},{"enrichment":"group.parent.limit.current.value"},{"enrichment":"group.parent.addressLine1"},{"enrichment":"group.parent.city"},{"enrichment":"group.parent.postalCode"},{"enrichment":"group.parent.country"},{"enrichment":"group.ultimateParent.id"},{"enrichment":"group.ultimateParent.safeNumber"},{"enrichment":"group.ultimateParent.name"},{"enrichment":"group.ultimateParent.companyNo"},{"enrichment":"group.ultimateParent.rating.current.score"},{"enrichment":"group.ultimateParent.rating.current.description.en"},{"enrichment":"group.ultimateParent.rating.current.description.nl"},{"enrichment":"group.ultimateParent.limit.current.value"},{"enrichment":"group.ultimateParent.country"},{"enrichment":"group.ultimateParent.entityType"},{"enrichment":"group.ultimateParent.isoCode"},{"enrichment":"group.ultimateParent.address"},{"enrichment":"group.ultimateParent.poBox"},{"enrichment":"group.ultimateParent.city"},{"enrichment":"group.ultimateParent.inseeCityCode"},{"enrichment":"group.ultimateParent.postalCode"},{"enrichment":"group.ultimateParent.contactPhone"},{"enrichment":"group.headquarter.id"},{"enrichment":"directors.title.en"},{"enrichment":"directors.title.nl"},{"enrichment":"directors.title.fr"},{"enrichment":"directors.firstName"},{"enrichment":"directors.fullNameKana"},{"enrichment":"directors.middleName"},{"enrichment":"directors.lastName"},{"enrichment":"directors.fullName"},{"enrichment":"directors.salutation"},{"enrichment":"directors.gender"},{"enrichment":"directors.addressLine1"},{"enrichment":"directors.addressLine2"},{"enrichment":"directors.addressLine3"},{"enrichment":"directors.addressLine4"},{"enrichment":"directors.city"},{"enrichment":"directors.region"},{"enrichment":"directors.state"},{"enrichment":"directors.postalCode"},{"enrichment":"directors.country"},{"enrichment":"directors.birthDate"},{"enrichment":"directors.birthPlace"},{"enrichment":"directors.appointmentDate"},{"enrichment":"directors.endDate"},{"enrichment":"directors.nationality"},{"enrichment":"directors.honours"},{"enrichment":"directors.managerPositionCode"},{"enrichment":"shareholders.name"},{"enrichment":"shareholders.info"},{"enrichment":"shareholders.currency"},{"enrichment":"general.isHeadquarter"}]}}},"components/schemas/JobMappingDto":{"id":"components/schemas/JobMappingDto","kind":"json-schema","title":"JobMappingDto","data":{"type":"object","required":["mapping","value"],"properties":{"mapping":{"type":"string","enum":["companyId","orgNumber","name","tradingName","aliasName","previousName","phone","email","address1","address2","address3","town","postcode","region","country","countryCode","vatNumber","taxCode","personalID","personalLimit"]},"value":{"type":"string","description":"Value follows array indexing, meaning each column is identified by number, starting at 0 "}},"example":{"mapping":"name","value":"0"}}},"components/schemas/ConnectDataCleaningUpdateMappingsRequest":{"id":"components/schemas/ConnectDataCleaningUpdateMappingsRequest","kind":"json-schema","title":"ConnectDataCleaningUpdateMappingsRequest","data":{"type":"object","required":["mappings"],"properties":{"mappings":{"type":"array","items":{"$ref":"#/components/schemas/JobMappingDto"}}}}},"components/schemas/ConnectDataCleaningMappingResponse":{"id":"components/schemas/ConnectDataCleaningMappingResponse","kind":"json-schema","title":"ConnectDataCleaningMappingResponse","data":{"type":"array","items":{"type":"object","properties":{"mapping":{"type":"string"},"value":{"type":"string"}}},"example":[{"mapping":"name","value":"0"}]}},"components/schemas/ConnectDataCleaningSubmitJobRequest":{"id":"components/schemas/ConnectDataCleaningSubmitJobRequest","kind":"json-schema","title":"ConnectDataCleaningSubmitJobRequest","data":{"type":"object"}},"components/schemas/MODEL28cf8d":{"id":"components/schemas/MODEL28cf8d","kind":"json-schema","title":"MODEL28cf8d","data":{"type":"object","required":["hasHeader","jobFile"],"properties":{"jobFile":{"type":"string","format":"binary","description":"The file to be uploaded"},"hasHeader":{"type":"boolean","description":"Indicates if the file has a header row"}}}},"components/schemas/ConnectDataCleaningUploadResponse":{"id":"components/schemas/ConnectDataCleaningUploadResponse","kind":"json-schema","title":"ConnectDataCleaningUploadResponse","data":{"type":"object","properties":{"id":{"type":"string"},"sourceFilename":{"type":"string"},"hasHeader":{"type":"boolean"},"createdAt":{"type":"string","format":"date-time"},"modifiedAt":{"type":"string","format":"date-time"},"managingUserId":{"type":"integer"},"managingCustomerId":{"type":"integer"},"status":{"type":"string"},"active":{"type":"boolean"}}}},"components/schemas/ConnectDecisionEngineRunDecisionResponse":{"id":"components/schemas/ConnectDecisionEngineRunDecisionResponse","kind":"json-schema","title":"ConnectDecisionEngineRunDecisionResponse","data":{"type":"object","properties":{"Decision":{"type":["string","null"],"description":"The decision returned by the automated decision model.","example":"Reject"},"DecisionText":{"type":["string","null"],"description":"The text output to accompany the decision returned by the decision model.","example":"The Sales Value requested is greater than Creditsafe's recommended credit limit."},"Audits":{"type":["array","null"],"description":"An array of audit values. The parameters output for audit are tailored and bespoke to each decision tree.","items":{"properties":{"description":{"type":["string","null"],"description":"The value for the audit parameter at the point in time in which the decision tree was run.","example":"A"},"RuleName":{"type":["string","null"],"description":"The friendly name for the audit parameter.","example":"International Score"}}}},"originationId":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Displays the optional text passed through to be stored against the decision in the original call to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/{provenirId}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Typically used for internal identifiers (e.g. SalesForce IDs)."},"children":[]}]}]}],"example":"SFC-1976"},"statusCode":{"type":["string","null"],"description":"The status of the decision. typically, 1 is reserved for positive outcomes, 2 for pending status and 3 for negative outcomes.","example":"3"}}}},"components/schemas/ConnectDecisionEngineUserDataFieldsResponse":{"id":"components/schemas/ConnectDecisionEngineUserDataFieldsResponse","kind":"json-schema","title":"ConnectDecisionEngineUserDataFieldsResponse","data":{"type":"object","properties":{"decisionEngineId":{"type":"string","description":"The unique reference for the decision tree.","example":"repoObj_0ed6a4aa_16e17d977e9_07ffb16e17d977e9"},"fields":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A list of user-input data fields that are supported by the provided decision tree. The values for these fields should be passed to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/{guid}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint call when running a decision."},"children":[]}]}]}],"items":{"properties":{"orderIndex":{"type":"number","description":"Used to assist ordering of the user data fields on a UI.","example":100},"label":{"type":"string","description":"The user-friendly label for the field for display on a UI.","example":"Product Type"},"paramName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The string value for the parameter to be used when calling the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/{guid}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}],"example":"productType"},"fieldType":{"type":"string","enum":["Text","Integer","Dropdown"],"description":"The type of user data field.","example":"Dropdown"},"mandatory":{"type":"boolean","description":"Flag to dictate whether the user data field is required when running the associated decision tree.","example":true},"dropdownDetails":{"type":["array","null"],"items":{"properties":{"label":{"type":"string","description":"The user-friendly label for the drop-down option for display on a UI.","example":"Product A"},"presentationOrder":{"type":"number","description":"Used to assist ordering of the drop-down options on a UI.","example":100}}}},"validation":{"type":["array","null"],"description":"Optional validation rules that should be applied to the corresponding user data field prior to running the decision tree.","items":{"properties":{"validationType":{"type":"string","enum":["Regex Match","Maximum","Minimum","Length","Custom"],"description":"The type of validation rule.","example":"Minimum"},"validationValue":{"type":"string","description":"The value for the validation rule.","example":"100"},"description":{"type":"string","description":"A description for the validation rule.","example":"Minimum Sales Value $100"}}}}}}}}}},"components/schemas/GetDecisionEngineDecisionOutcomeResponse":{"id":"components/schemas/GetDecisionEngineDecisionOutcomeResponse","kind":"json-schema","title":"GetDecisionEngineDecisionOutcomeResponse","data":{"type":"object","properties":{"correlationId":{"type":"string","description":"A unique ID assigned to this request.","example":"23921650-c073-11ea-860f-06bc8182190e"},"includeInManualReview":{"type":"boolean","description":"This key is used to enable or restrict the manual review process for pending status.","example":true},"decisionOutcomes":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"status":{"type":"number","description":"The status of the decision. typically, 1 is reserved for positive outcomes, 2 for pending status, 3 for negative outcomes,5 for manually approved outcomes and 6 for manually rejected outcomes."},"label":{"type":"string","description":"Value that is typically chosen to depict the possible outcome for different statuses."},"description":{"type":"string","description":"Statement that defines the reasoning behind an outcome for a status."}}}}}}}}},"components/schemas/ConnectDecisionEnginePatchDecisionOutcomeRequest":{"id":"components/schemas/ConnectDecisionEnginePatchDecisionOutcomeRequest","kind":"json-schema","title":"ConnectDecisionEnginePatchDecisionOutcomeRequest","data":{"type":"object","properties":{"includeInManualReview":{"type":"boolean","description":"This key is used to enable or restrict the manual review process for pending status.","example":true},"decisionOutcomes":{"type":"array","items":{"type":"object","properties":{"status":{"type":"number","description":"The status of the decision. typically, 1 is reserved for positive outcomes, 2 for pending status, 3 for negative outcomes, 5 for manually approved outcomes and 6 for manually rejected outcomes."},"label":{"type":"string","description":"Value that is typically chosen to depict the possible outcome for different statuses."},"description":{"type":"string","description":"Statement that defines the reasoning behind an outcome for a status."}}}}}}},"components/schemas/ConnectDecisionEngineGUIDListResponse":{"id":"components/schemas/ConnectDecisionEngineGUIDListResponse","kind":"json-schema","title":"ConnectDecisionEngineGUIDListResponse","data":{"type":"object","properties":{"correlationId":{"type":"string","description":"A unique ID assigned to this request.","example":"23921650-c073-11ea-860f-06bc8182190e"},"GUIDList":{"type":"array","items":{"properties":{"friendlyName":{"type":"string","description":"The name of the decision tree.","example":"Check & Decide Demo"},"GUID":{"type":"string","description":"The unique reference for the decision tree.","example":"repoObj_0ed6a4aa_16e17d977e9_07ffb16e17d977e9"},"type":{"type":"string","enum":["Credit Approval","Bespoke","Demo"],"description":"The type of the decision tree."},"serviceLine":{"type":["string","null"],"description":"The internal reference for the service line that credits will be deducted from on each decision tree run.","example":"dec_eng_cas"}}}}}}},"components/schemas/UpdateDecisionEngineInstanceRequestBody":{"id":"components/schemas/UpdateDecisionEngineInstanceRequestBody","kind":"json-schema","title":"UpdateDecisionEngineInstanceRequestBody","data":{"type":"object","required":["templateId","guid","decisionTreeName"],"properties":{"templateId":{"description":"The template ID of the decision tree to be updated.","example":"72a7e73e799a4c3ea2a8b89bd2002829","type":"string"},"guid":{"description":"The GUID to be updated.","example":"02dce1bbb81b11ed962c01ff1787b18e","type":"string"},"decisionTreeName":{"description":"The name of the decision tree to be updated.","example":"Test US after NL test update5","type":"string"},"customerId":{"description":"The customer ID to be updated.","example":103361848,"type":"integer"},"inputParams":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The input parameters to be updated can be obtained from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET/instance configuration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}],"type":"object"},"configurationVariables":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Configuration Variables to be updated can be obtained from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET/instance configuration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}],"type":"object"},"scalarVariables":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Scalar Variables to be updated can be obtained from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET/instance configuration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}],"type":"object"}}}},"components/schemas/UpdateDecisionEngineInstanceRequestBodyWithExample":{"id":"components/schemas/UpdateDecisionEngineInstanceRequestBodyWithExample","kind":"json-schema","title":"UpdateDecisionEngineInstanceRequestBodyWithExample","data":{"allOf":[{"$ref":"#/components/schemas/UpdateDecisionEngineInstanceRequestBody"},{"type":"object","example":{"templateId":"72a7e73e799a4c3ea2a8b89bd2002829","guid":"232101f5cfbf11edb2a53f274007bfbe","decisionTreeName":"Default US-Test Tree","publilshed":true,"customerId":103361848,"inputParams":{"creditAmount":{"labelName":"Sales Amount","failedStatus":3,"unavailableStatus":2,"isMandatory":true,"orderInde":100,"fieldType":"Integer"}},"configurationVariables":{"companyStatus":{"isRequired":true,"failedStatus":2,"unavailableStatus":2},"internationalScore":{"isRequired":true,"failedStatus":2,"unavailableStatus":2,"value":"B"},"riskScore":{"isRequired":true,"failedStatus":2,"unavailableStatus":2,"value":50},"dbt":{"isRequired":true,"failedStatus":2,"unavailableStatus":2,"value":1},"possibleOFAC":{"isRequired":true,"failedStatus":2,"unavailableStatus":2},"estimatedAnnualRevenue":{"isRequired":true,"failedStatus":2,"unavailableStatus":2,"value":1000},"yearsInBusiness":{"isRequired":true,"failedStatus":2,"unavailableStatus":2,"value":5},"derogatoryLegalFilingsCount":{"isRequired":true,"failedStatus":2,"unavailableStatus":2,"value":3},"derogatoryLegalFilingsValue":{"isRequired":true,"failedStatus":2,"unavailableStatus":2,"value":1000},"numberOfEmployees":{"isRequired":true,"failedStatus":2,"unavailableStatus":2,"value":1000},"bankruptcy":{"isRequired":true,"failedStatus":2,"unavailableStatus":2},"totalNumberOfTradeLines":{"isRequired":true,"failedStatus":2,"unavailableStatus":2,"value":25},"percentageOfTotalPastDue":{"isRequired":true,"failedStatus":2,"unavailableStatus":2,"value":15},"percentageSeverelyPastDue":{"isRequired":true,"failedStatus":2,"unavailableStatus":2,"value":10},"businessCompliance":{"isRequired":false,"failedStatus":null,"unavailableStatus":2,"value":null},"directorCompliance":{"isRequired":true,"failedStatus":null,"unavailableStatus":null,"value":null}},"scalarVariables":{"creditLimitAdjustmentModifier":{"isRequired":false,"value":1}}}}]}},"components/schemas/GetDecisionEngineInstancesResponse":{"id":"components/schemas/GetDecisionEngineInstancesResponse","kind":"json-schema","title":"GetDecisionEngineInstancesResponse","data":{"properties":{"correlationId":{"description":"A unique ID assigned to this request.","type":"string"},"instances":{"description":"The list of decision trees and GUID's available to user.","items":{"properties":{"decisionTreeName":{"type":"string"},"guid":{"type":"string"}},"type":"object"},"type":"array"}},"type":"object"}},"components/schemas/ConnectDecisionEngineUsageLogResponse":{"id":"components/schemas/ConnectDecisionEngineUsageLogResponse","kind":"json-schema","title":"ConnectDecisionEngineUsageLogResponse","data":{"type":"object","properties":{"totalCount":{"type":"number","description":"The total number of previous decisions matching the defined filter criteria.","example":3108},"usageLog":{"type":"array","items":{"properties":{"decisionLogId":{"type":"number","description":"The unique identifier for the decision log.","example":64492},"provenirId":{"type":"string","description":"The unique identifier of the decision tree.","example":"repoObj_0ed6a4aa_16e17d977e9_07ffb16e17d977e9"},"friendlyName":{"type":"string","description":"The name of the decision tree.","example":"Check & Decide Demo"},"userId":{"type":"number","description":"The unique identifier for the user's account, used across the Creditsafe product suite.","example":101445010},"companyId":{"type":"string","description":"The connectId of the company that the decision was ran on. A connectId is the primary Company identifier that is used to uniquely identify all companies across Creditsafe's Universe and Partner Network.","example":"US001-X-US60521352"},"companyName":{"type":["string","null"],"description":"The name of the company that the decision was ran on.","example":"CREDITSAFE USA INC."},"response":{"type":"object","properties":{"Decision":{"type":"string","description":"The decision returned by the automated decision model.","example":"Reject"},"DecisionText":{"type":"string","description":"The text output to accompany the decision returned by the decision model.","example":"The Sales Value requested is greater than Creditsafe's recommended credit limit."},"Audits":{"type":"array","description":"An array of audit values. The parameters output for audit are tailored and bespoke to each decision tree.","items":{"properties":{"description":{"type":"string","description":"The value for the audit parameter at the point in time in which the decision tree was run.","example":"A"},"RuleName":{"type":"string","description":"The friendly name for the audit parameter.","example":"International Score"}}}},"originationId":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Displays the optional text passed through to be stored against the decision in the original call to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/{provenirId}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Typically used for internal identifiers (e.g. SalesForce IDs)."},"children":[]}]}]}],"example":"SFC-1976"},"statusCode":{"type":"string","description":"The status of the decision. typically, 1 is reserved for positive outcomes, 2 for pending status and 3 for negative outcomes.","example":"3"}}},"decisionDate":{"type":"string","format":"date-time","description":"The timestamp that the decision model was run."},"notes":{"type":["string","null"],"description":"The notes associated with this decision."},"status":{"type":"number","description":"The status of the decision. typically, 1 is reserved for positive outcomes, 2 for pending status and 3 for negative outcomes.","example":3}}}}}}},"components/schemas/ConnectDecisionEngineDecisionLogResponse":{"id":"components/schemas/ConnectDecisionEngineDecisionLogResponse","kind":"json-schema","title":"ConnectDecisionEngineDecisionLogResponse","data":{"type":"object","properties":{"correlationId":{"type":"string","description":"A unique ID assigned to this request.","example":"23921650-c073-11ea-860f-06bc8182190e","deprecated":true},"decisionLogId":{"type":"number","description":"The unique identifier for the decision log.","example":64492},"provenirId":{"type":"string","description":"The unique identifier of the decision tree.","example":"repoObj_0ed6a4aa_16e17d977e9_07ffb16e17d977e9"},"friendlyName":{"type":"string","description":"The name of the decision tree.","example":"Check & Decide Demo"},"userId":{"type":"number","description":"The unique identifier for the user's account, used across the Creditsafe product suite.","example":101445010},"companyId":{"type":"string","description":"The connectId of the company that the decision was ran on. A connectId is the primary Company identifier that is used to uniquely identify all companies across Creditsafe's Universe and Partner Network.","example":"US001-X-US60521352"},"companyName":{"type":["string","null"],"description":"The name of the company that the decision was ran on.","example":"CREDITSAFE USA INC."},"response":{"$ref":"#/components/schemas/ConnectDecisionEngineRunDecisionResponse"},"decisionDate":{"type":"string","format":"date-time","description":"The timestamp that the decision model was run."},"notes":{"type":["string","null"],"description":"The notes associated with this decision."},"status":{"type":"number","description":"The status of the decision. typically, 1 is reserved for positive outcomes, 2 for pending status and 3 for negative outcomes.","example":3},"modifiedDate":{"type":"string","format":"date-time","description":"The timestamp that this decision was last modified."}}}},"components/schemas/ConnectDecisionEngineUpdateDecisionRequest":{"id":"components/schemas/ConnectDecisionEngineUpdateDecisionRequest","kind":"json-schema","title":"ConnectDecisionEngineUpdateDecisionRequest","data":{"type":"object","properties":{"statusCode":{"type":"number","description":"The status that the decision will be updated to. Typically, 1 is reserved for positive outcomes, 2 for pending status and 3 for negative outcomes.","example":1},"notes":{"type":"string","description":"Free text field to allow for the saving of notes on the associated decision object.","example":"Manually approved by Senior Credit Controller."}}}},"components/schemas/ConnectFreshInvListInvestigations":{"id":"components/schemas/ConnectFreshInvListInvestigations","kind":"json-schema","title":"ConnectFreshInvListInvestigations","data":{"type":"object","properties":{"totalCount":{"type":"integer"},"orders":{"type":"array","items":{"type":"object","properties":{"orderID":{"type":"integer","description":"Fresh Investigation Unique Identifier"},"userID":{"type":"string","description":"Fresh Investigation user Identifier"},"creationDate":{"type":"string","description":"Fresh Investigation Creation Date"},"lastStatusChangeDate":{"type":"string","description":"Fresh Investigation Last Status Change Date"},"transactionID":{"type":"integer","description":"Fresh Investigation Internal Identifier"},"chargeReference":{"type":"string"},"contactDetails":{"type":"object","description":"Contact details of the person who requested the investigation, and where the information will be sent.","properties":{"name":{"type":"string","description":"Contact name of the person who requested the investigation"},"emailAddress":{"type":"string","description":"The address to which the investigation report will be sent"},"telephoneNumber":{"type":"string","description":"Your telephone number"}}},"sectionNames":{"type":"string"},"status":{"type":"object","description":"The status of the investigation","properties":{"code":{"type":"string"},"description":{"type":"string"}}},"consent":{"type":"boolean","description":"Whether permission was granted by the requesting company to disclose the identity of the investigating party to the target company."},"searchCriteria":{"type":"object","description":"The search criteria used to perform the investigation","properties":{"name":{"type":"string","description":"Target company name"},"vatNo":{"type":"string"},"regNo":{"type":"string"},"additionalInfo":{"type":"string"},"address":{"$ref":"#/components/schemas/CreditsafeGlobalDataAddressData"}}},"reportDate":{"type":"string","format":"date-time"}}}}}}},"components/schemas/ConnectFreshInvCreateInvestigation":{"id":"components/schemas/ConnectFreshInvCreateInvestigation","kind":"json-schema","title":"ConnectFreshInvCreateInvestigation","data":{"type":"object","properties":{"consent":{"type":"boolean","description":"Including this allows Creditsafe to disclose your company details to the target company in the aim of improving the quality of our Investigation Report"},"contactInfo":{"description":"Your contact information","type":"object","properties":{"name":{"type":"string","description":"Your name"},"emailAddress":{"type":"string","description":"The address where Investigation creation confirmations are sent"},"telephoneNumber":{"type":["string","null"],"description":"Your contact number"},"company":{"type":"object","description":"your company information","properties":{"name":{"type":"string","description":"Your company name"},"number":{"type":"string","description":"Your company VAT number/Reg Number/Tax Number"}}}}},"chargeReference":{"type":"string","description":"Free text field to add your own personal reference to the order"},"searchCriteria":{"type":"object","description":"Details on the company you are investigating - the target company","properties":{"name":{"type":"string","description":"Target company name"},"additionalInfo":{"type":["string","null"],"description":"Any further details on your target company that will assist our Investigation"},"telephoneNumber":{"type":["string","null"],"description":"Target company telephone number"},"address":{"type":["object","null"],"description":"Target company address","properties":{"simple":{"type":"string"},"postcode":{"type":"string"},"city":{"type":"string"}}},"regNo":{"type":["string","null"],"description":"Target company registration number"},"vatNo":{"type":["string","null"],"description":"Target company VAT number"},"countryCode":{"type":"string","description":"Target company ISO2 country code"}}}}}},"components/schemas/ConnectFreshInvInvestigationConfirmed":{"id":"components/schemas/ConnectFreshInvInvestigationConfirmed","kind":"json-schema","title":"ConnectFreshInvInvestigationConfirmed","data":{"type":"object","properties":{"correlationId":{"type":"string","description":"A unique ID assigned to this request."},"message":{"type":"string"},"orderID":{"type":"string","description":"Fresh Investigation Unique Identifier"},"transactionID":{"type":"string","description":"Fresh Investigation Internal Identifier"}}}},"components/schemas/ConnectFreshInvCompletedInvestigation":{"id":"components/schemas/ConnectFreshInvCompletedInvestigation","kind":"json-schema","title":"ConnectFreshInvCompletedInvestigation","data":{"type":"object","properties":{"chargeReference":{"type":"string"},"contactDetails":{"properties":{"emailAddress":{"type":"string"},"name":{"type":"string"},"telephoneNumber":{"type":"string"}},"type":"object"},"creationDate":{"type":"string"},"lastStatusChangeDate":{"type":"string"},"orderID":{"type":"integer"},"reportDate":{"type":"string"},"searchCriteria":{"properties":{"additionalInfo":{"type":"string"},"address":{"properties":{"city":{"type":"string"},"postcode":{"type":"string"},"simple":{"type":"string"}},"type":"object"},"countryCode":{"type":"string"},"name":{"type":"string"},"regNo":{"type":"string"},"vatNo":{"type":"string"}},"type":"object"},"sections":{"items":{"anyOf":[{"properties":{"content":{"type":"string"},"contentType":{"type":"string"},"creationDate":{"type":"string"},"name":{"type":"string"}},"type":"object"}]},"type":"array"},"status":{"properties":{"code":{"type":"string"},"description":{"type":"string"}},"type":"object"},"transactionID":{"type":"integer"}}}},"components/schemas/DeleteFreshInvetigationsByOrderId":{"id":"components/schemas/DeleteFreshInvetigationsByOrderId","kind":"json-schema","title":"DeleteFreshInvetigationsByOrderId","data":{"type":"object","properties":{"message":{"type":"string"}}}},"components/schemas/ConnectFreshInvInvestigationContactInfo":{"id":"components/schemas/ConnectFreshInvInvestigationContactInfo","kind":"json-schema","title":"ConnectFreshInvInvestigationContactInfo","data":{"description":"Your contact information","type":"object","additionalProperties":false,"properties":{"name":{"type":"string","description":"Your name"},"emailAddress":{"type":"string","description":"The address where Investigation creation confirmations are sent"},"telephoneNumber":{"type":["string","null"],"description":"Your contact number"},"company":{"type":"object","additionalProperties":false,"description":"your company information","properties":{"name":{"type":"string","description":"Your company name"},"number":{"type":"string","description":"Your company VAT number/Reg Number/Tax Number"}}}}}},"components/schemas/ConnectFreshInvInvestigationCompanyData":{"id":"components/schemas/ConnectFreshInvInvestigationCompanyData","kind":"json-schema","title":"ConnectFreshInvInvestigationCompanyData","data":{"type":"object","additionalProperties":false,"description":"Details on the company.","properties":{"name":{"type":"string","description":"Company name."},"additionalInfo":{"type":"string","description":"Further details on the company."},"telephoneNumber":{"type":"string","description":"Company telephone number"},"address":{"type":"object","additionalProperties":false,"description":"Company address","properties":{"simple":{"type":"string"},"postcode":{"type":"string"},"city":{"type":"string"}}},"regNo":{"type":"string","description":"Company registration number"},"vatNo":{"type":"string","description":"Company VAT number"},"countryCode":{"$ref":"#/components/schemas/CreditsafeGlobalDataCountryCode"}}}},"components/schemas/ConnectUpdateFreshInvestigation":{"id":"components/schemas/ConnectUpdateFreshInvestigation","kind":"json-schema","title":"ConnectUpdateFreshInvestigation","data":{"type":"object","additionalProperties":false,"properties":{"consent":{"type":"boolean","description":"Including this allows Creditsafe to disclose your company details to the target company in the aim of improving the quality of our Investigation Report"},"contactInfo":{"$ref":"#/components/schemas/ConnectFreshInvInvestigationContactInfo"},"chargeReference":{"type":"string","description":"Free text field to add your own personal reference to the order"},"searchCriteria":{"$ref":"#/components/schemas/ConnectFreshInvInvestigationCompanyData"},"pendingInfo":{"type":"object","description":"PendingInfo property contains the information of respective sections, that someone has requested respective information to be modified.","properties":{"contactDetails":{"description":"Your Contact details of fresh investigation for updating.","$ref":"#/components/schemas/ConnectFreshInvInvestigationContactInfo"},"searchCriteria":{"description":"Search criteria details of the company.","$ref":"#/components/schemas/ConnectFreshInvInvestigationCompanyData"}}}}}},"components/schemas/FreshInvestigationGetAttachmentsForOrderResponse":{"id":"components/schemas/FreshInvestigationGetAttachmentsForOrderResponse","kind":"json-schema","title":"FreshInvestigationGetAttachmentsForOrderResponse","data":{"description":"Attachments for the fresh investigation order","type":"object","additionalProperties":false,"properties":{"correlationId":{"type":"string","description":"A unique ID assigned to this request."},"Attachments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"fileName":{"type":"string"},"fileType":{"type":"string"},"description":{"type":"string"}}}}}}},"components/schemas/FreshInvestigationAttachmentUploadForOrderRequest":{"id":"components/schemas/FreshInvestigationAttachmentUploadForOrderRequest","kind":"json-schema","title":"FreshInvestigationAttachmentUploadForOrderRequest","data":{"type":"object","additionalProperties":false,"properties":{"importFile":{"type":"string","format":"binary","description":"The file which we want to attach to the fresh investigation order"},"description":{"type":"string","description":"Description of the file which we want to attach to the fresh investigation order"}}}},"components/schemas/FreshInvestigationAttachmentUploadForOrderResponse":{"id":"components/schemas/FreshInvestigationAttachmentUploadForOrderResponse","kind":"json-schema","title":"FreshInvestigationAttachmentUploadForOrderResponse","data":{"description":"Attachment upload status for the order","type":"object","additionalProperties":false,"properties":{"correlationId":{"type":"string","description":"A unique ID assigned to this request."},"message":{"type":"string"},"details":{"type":"string"}}}},"components/schemas/CreditsafeFreshInvestigationGlobalDataCoreAttachmentBinaryAttachment":{"id":"components/schemas/CreditsafeFreshInvestigationGlobalDataCoreAttachmentBinaryAttachment","kind":"json-schema","title":"CreditsafeFreshInvestigationGlobalDataCoreAttachmentBinaryAttachment","data":{"type":"string","format":"binary"}},"components/schemas/GetFreshInvestigationCommentsByOrderIdResponse":{"id":"components/schemas/GetFreshInvestigationCommentsByOrderIdResponse","kind":"json-schema","title":"GetFreshInvestigationCommentsByOrderIdResponse","data":{"type":"object","properties":{"totalCount":{"type":"integer","description":"Total number of comments for a FreshInvestigation Report"},"comments":{"type":"array","items":{"type":"object","properties":{"userID":{"type":"string","example":"CSC_123456","description":"user id"},"comment":{"type":"string","example":"testing comments","description":"comments about the FreshInvestigation Report"},"creationDate":{"type":"string","example":"2023-03-10T05:44:06.000Z","description":"The time when comment has been posted."}}}}}}},"components/schemas/FreshInvestigationCommentsForOrderRequest":{"id":"components/schemas/FreshInvestigationCommentsForOrderRequest","kind":"json-schema","title":"FreshInvestigationCommentsForOrderRequest","data":{"type":"object","additionalProperties":false,"properties":{"comments":{"description":"comments for fresh investigation orderId","type":"string"}}}},"components/schemas/FreshInvestigationCommentsForOrderResponse":{"id":"components/schemas/FreshInvestigationCommentsForOrderResponse","kind":"json-schema","title":"FreshInvestigationCommentsForOrderResponse","data":{"description":"comments for the fresh investigation orderId","type":"object","additionalProperties":false,"properties":{"correlationId":{"type":"string","description":"A unique ID assigned to this request."},"message":{"type":"string"}}}},"components/schemas/CreditsafeGlobalDataCoreAttachmentBinaryAttachment":{"id":"components/schemas/CreditsafeGlobalDataCoreAttachmentBinaryAttachment","kind":"json-schema","title":"CreditsafeGlobalDataCoreAttachmentBinaryAttachment","data":{"type":"string","format":"binary"}},"components/schemas/ConnectImagesCompanyImages":{"id":"components/schemas/ConnectImagesCompanyImages","kind":"json-schema","title":"ConnectImagesCompanyImages","data":{"type":"object","properties":{"correlationId":{"type":"string","description":"Unique identifier for tracing this request, enabling tracking and debugging."},"totalSize":{"type":"integer","description":"Total number of image records available based on the query criteria."},"data":{"type":"array","items":{"type":"object","properties":{"imageId":{"type":"string","description":"Unique identifier for the image document, allowing direct retrieval and reference."},"company":{"type":"object","description":"Contains information about the company associated with the image. This includes identifiers, \nthe registered country, legal type, and other basic details specific to the company in question.\n","properties":{"id":{"type":"string","description":"Unique identifier for the company."},"localId":{"type":"string","description":"Company identifier specific to the country or jurisdiction."},"country":{"type":"string","description":"ISO code representing the country where the company is registered."},"name":{"type":"string","description":"Official registered name of the company."},"type":{"type":"string","description":"Legal structure or type of the company, such as \"Ltd\" for limited companies."},"additionalInformation":{"type":"object","properties":{"legalGroup":{"type":"string","description":"Classification indicating the company's legal grouping or ownership structure.","example":"OVR"}}}}},"document":{"type":"object","description":"Provides details about the specific document or image associated with the company, \nsuch as its type, code, and a description that may include filing information or updates.\n","properties":{"imageType":{"type":"string","description":"Type of document image, e.g., \"AnnualReturns\" or \"ConfirmationStatement.\""},"imageTypeCode":{"type":"string","description":"Code associated with the document type for internal or regulatory identification."},"imageTypeDescription":{"type":"string","description":"Detailed description of the document, often including information about its contents or updates."}}},"filingDate":{"type":"string","format":"date","description":"Date when the document was officially filed or recorded."},"startDate":{"type":"string","format":"date","description":"Start date of the time period covered by the document."},"endDate":{"type":"string","format":"date","description":"End date of the time period covered by the document."},"language":{"type":"string","description":"ISO language code representing the document's primary language."},"consolidated":{"type":"boolean","description":"Indicates if the document contains consolidated information, typically applicable to financial statements."},"publicationDate":{"type":"string","format":"date-time","description":"Date and time when the document was published or made available."},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Document or image status, currently only available for Netherlands "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"availableFormats":{"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":"List of available formats for the image, currently only available for Denmark "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DK"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"additionalInformation":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional details about the document. Note that properties within "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"additionalInformation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" may vary depending on the country."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not all properties listed below are available for every country, and some properties may not appear at all in certain responses."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integrations should allow flexibility to handle missing or variable properties."},"children":[]}]}]}],"type":"object","properties":{"annotations":{"type":"string","description":"Annotations related to the image"},"barcode":{"type":"string","description":"Unique barcode for tracking or inventory purposes, associated with the document."},"category":{"type":"string","description":"Main category of the document, such as \"confirmation-statement.\""},"descriptionValues":{"type":"object","description":"Description values (object structure may vary by country)"},"imageStatus":{"type":"string","description":"Current processing status of the image, e.g., \"Pending\" or \"Completed.\""},"pages":{"type":"integer","description":"Number of pages in the document"},"paperFiled":{"type":"boolean","description":"Indicates if the image was filed on paper"},"resolutions":{"type":"array","items":{"type":"string"},"description":"List of resolutions related to the image"},"sourceType":{"type":"string","description":"Specific source or origin type for the document, providing additional context (e.g., \"confirmation-statement-with-no-updates\")."},"subcategory":{"type":"string","description":"Further classification within the main category; may be blank if not applicable."},"transactionId":{"type":"string","description":"Transaction ID related to the image"}}}}}}}}},"components/schemas/ConnectImagesCompanyImageTypes":{"id":"components/schemas/ConnectImagesCompanyImageTypes","kind":"json-schema","title":"ConnectImagesCompanyImageTypes","data":{"type":"array","description":"List of country-specific configurations, including requirements and validations for company ID and image reference fields, as well as supported languages and filing types.","items":{"type":"object","properties":{"country":{"type":"string","description":"ISO code representing the country to which this configuration applies."},"companyId":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Configuration details for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"companyId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field, specifying whether it is required"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and any validation rules, such as minimum and maximum length and allowed patterns."},"children":[]}]}]}],"properties":{"required":{"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 a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"companyId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required for this country."},"children":[]}]}]}]},"validationRegExp":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Regular expression for validating the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"companyId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format for this country."},"children":[]}]}]}]},"minLength":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Minimum length for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"companyId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", if applicable."},"children":[]}]}]}]},"maxLength":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum length for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"companyId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", if applicable."},"children":[]}]}]}]}}},"imageReference":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Configuration details for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"imageReference"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field, specifying its requirement status,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"validation rules, and length constraints for the country in question."},"children":[]}]}]}],"properties":{"required":{"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 an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"imageReference"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required for this country."},"children":[]}]}]}]},"validationRegExp":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Regular expression for validating the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"imageReference"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}]},"minLength":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Minimum length for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"imageReference"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", if applicable."},"children":[]}]}]}]},"maxLength":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum length for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"imageReference"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", if applicable."},"children":[]}]}]}]}}},"availableLanguages":{"type":"array","description":"List of languages available for documents in this country, along with filing types and formats.","items":{"type":"object","properties":{"language":{"type":"string","description":"Language code for documents available in this country (e.g., \"EN\" for English)."},"filingTypes":{"type":"array","description":"List of filing types available in this language, with supported formats.","items":{"type":"object","properties":{"type":{"type":"string","description":"Type of filing, such as \"AnnualReport\" or \"Statement.\""},"availableFormats":{"type":"array","description":"List of file formats available for this filing type (e.g., \"PDF\" or \"HTML\").","items":{"type":"string"}}}}},"default":{"type":"boolean","description":"Indicates if this language is the default language for documents in this country."}}}}}}}},"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/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/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/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/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/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/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/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/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/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/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/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/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"}}}}]}]}},"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/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/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/ConnectMonitoringPaging":{"id":"components/schemas/ConnectMonitoringPaging","kind":"json-schema","title":"ConnectMonitoringPaging","data":{"type":"object","description":"Paging parameters.","properties":{"size":{"type":["number","null"],"description":"The maximum number of results returned per page.","example":10},"prev":{"type":["number","null"],"description":"The page number of the previous page, null if there is no previous page available.","example":0},"next":{"type":["number","null"],"description":"The page number of the next page, null if there is no next page available.","example":2},"last":{"type":["number","null"],"description":"The page number of the last page.","example":3}}}},"components/schemas/ConnectMonitoringCompanyEvents":{"id":"components/schemas/ConnectMonitoringCompanyEvents","kind":"json-schema","title":"ConnectMonitoringCompanyEvents","data":{"type":"object","properties":{"correlationId":{"type":"string","description":"A unique ID assigned to this request.","example":"23921650-c073-11ea-860f-06bc8182190e"},"totalCount":{"type":"number","description":"The total number of events returned for the given company.","example":1},"data":{"type":"array","items":{"type":"object","properties":{"eventId":{"type":"number","description":"The unique identifier for the event.","example":192873729},"companyId":{"type":"string","description":"The Safe Number (Creditsafe's identifier on all Companies owned in the Creditsafe Universe) of the company that triggered the event.","example":"UK00004371"},"portfolioId":{"type":"number","description":"The portfolio Id of the portfolio that contains the company that you requested event information for.","example":589960},"ruleName":{"type":"string","description":"A short description of the company event.","example":"Credit Limit Change"},"localEventCode":{"type":"string","description":"The local event code for the event.","example":"CL"},"globalEventCode":{"type":"string","description":"The global event code that has been mapped to the local event.","example":"CL"},"newValue":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Some events contain an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"oldValue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"newValue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (e.g. a change in Credit Limit)."},"children":[]}]}]}],"example":7050000},"oldValue":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Some events contain an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"oldValue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"newValue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (e.g. a change in Credit Limit)."},"children":[]}]}]}],"example":6100000},"eventDate":{"type":"string","format":"date-time","description":"The date that the event occurred.","example":"2019-03-14T22:21:50"},"createdDate":{"type":"string","format":"date-time","description":"The date that the event was created in the Creditsafe database.","example":"2019-03-14T22:21:50"}}}},"paging":{"$ref":"#/components/schemas/ConnectMonitoringPaging"}}}},"components/schemas/ConnectMonitoringEventRulesResponse":{"id":"components/schemas/ConnectMonitoringEventRulesResponse","kind":"json-schema","title":"ConnectMonitoringEventRulesResponse","data":{"type":"array","items":{"properties":{"isActive":{"type":"boolean","description":"Shows whether the notification event rule has been enabled for the given portfolio.","example":0},"ruleCode":{"type":"number","description":"The unique identifier for the notification event rule.","example":101},"ruleCountryCode":{"type":"string","description":"The ISO/Alpha 2 format country code for the notification event rule. \"XX\" is used for global rules that apply to companies from all countries.","example":"XX"},"ruleType":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ruleType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the notification event rule."},"children":[]}]}]}],"example":4},"ruleTypeName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A short description of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ruleType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the notification event rule."},"children":[]}]}]}],"example":"Rating band change - 3 input"},"name":{"type":"string","description":"The name for the notification event rule.","example":"International Rating | Reduce by {0} Band(s) OR Less than Band {1}"},"param0":{"type":"string","description":"Some notification event rules may include input parameters used to tailor the notifications generated to your preference.","example":"1"},"param1":{"type":"string","description":"Some notification event rules may include input parameters used to tailor the notifications generated to your preference.","example":"A"}}}}},"components/schemas/ConnectMonitoringCompanyInfo":{"id":"components/schemas/ConnectMonitoringCompanyInfo","kind":"json-schema","title":"ConnectMonitoringCompanyInfo","data":{"type":"object","properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The connectId of the company that triggered the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"notificationEvent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A connectId is the primary Company identifier that is used to uniquely identify all companies across Creditsafe's Universe and Partner Network."},"children":[]}]}]}],"example":"US-X-US22384484"},"safeNumber":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Safe Number (Creditsafe's identifier on all Companies owned in the Creditsafe Universe) of the company that triggered the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"notificationEvent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"US22384484"},"name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the company that triggered the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"notificationEvent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"GOOGLE LLC"},"countryCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO/Alpha 2 format country code of the company that triggered the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"notificationEvent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"US"},"portfolioId":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The portfolio Id of the portfolio that contains the company that triggered the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"notificationEvent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":589960},"portfolioName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the portfolio that contains the company that triggered the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"notificationEvent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"Default"}}}},"components/schemas/ConnectMonitoringAllNotificationsEvents":{"id":"components/schemas/ConnectMonitoringAllNotificationsEvents","kind":"json-schema","title":"ConnectMonitoringAllNotificationsEvents","data":{"type":"object","properties":{"correlationId":{"type":"string","description":"A unique ID assigned to this request.","example":"23921650-c073-11ea-860f-06bc8182190e"},"totalCount":{"type":"number","description":"The total number of events returned for the given company.","example":36},"data":{"type":"array","items":{"properties":{"company":{"$ref":"#/components/schemas/ConnectMonitoringCompanyInfo"},"eventId":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier of the event that triggered the generation of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"notificationEvent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This identifier is consistent across all portfolios in the Global Monitoring product."},"children":[]}]}]}],"example":426992366},"eventDate":{"type":"string","format":"date-time","description":"The date that the event occurred.","example":"2019-12-06T08:23:37"},"newValue":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Some events contain an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"oldValue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"newValue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (e.g. a change in Credit Limit)."},"children":[]}]}]}],"example":"1600 AMPHITHEATRE PARKWAY, MOUNTAIN VIEW, CA, 94043-1351"},"oldValue":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Some events contain an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"oldValue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"newValue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (e.g. a change in Credit Limit)."},"children":[]}]}]}],"example":"1604 AMPHITHEATRE PARKWAY, MOUNTAIN VIEW, CA, 94043-1351"},"notificationEventId":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"notificationEvent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This identifier is tied to a specific "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eventId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"portfolioId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":51861887},"notificationId":{"type":["number","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"notificationEvent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This identifier is tied to a specific "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eventId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"portfolioId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":null},"processedDate":{"type":["string","null"],"format":"date-time","description":"If the Notification was sent by email, the date will be populated with when the notification was sent.","example":null},"ruleCode":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ruleCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that triggered the generation of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"notificationEvent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":105},"ruleName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the notification event rule that triggered the generation of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"notificationEvent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"Address"},"summary":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A short description of the notification event rule that triggered the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"notificationEvent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"Address Change reported"},"ruleText":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A short description of the notification event rule that triggered the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"notificationEvent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"Address Change reported"},"localEventCode":{"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 local code of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"notificationEvent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"LI2013"},"isProcessed":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" flag for each event to indicate whether the system has performed an action on the notification."},"children":[]}]}]}],"example":true}}}},"paging":{"$ref":"#/components/schemas/ConnectMonitoringPaging"}}}},"components/schemas/ConnectMonitoringListPortfolios":{"id":"components/schemas/ConnectMonitoringListPortfolios","kind":"json-schema","title":"ConnectMonitoringListPortfolios","data":{"type":"object","properties":{"correlationId":{"type":"string","description":"A unique ID assigned to this request.","example":"23921650-c073-11ea-860f-06bc8182190e"},"totalCount":{"type":"number","description":"The total number of portfolios returned for the logged in user.","example":1},"paging":{"$ref":"#/components/schemas/ConnectMonitoringPaging"},"data":{"type":"object","properties":{"portfolios":{"type":"array","items":{"properties":{"portfolioId":{"type":"number","description":"A unique ID assigned to each portfolio.","example":131318},"name":{"type":"string","description":"The name of the portfolio","example":"Customers 2"},"isDefault":{"type":"string","description":"A true or false value which shows if the portfolio is set as default","example":false},"emails":{"type":"array","items":{"properties":{"firstName":{"type":"string","description":"The first name of the user to receive the email notification.","example":"John"},"lastName":{"type":"string","description":"The last name of the user to receive the email notification.","example":"Doe"},"email":{"type":"string","description":"The email address of the user to receive the email notification.","example":"john.doe@creditsafe.com"}}}},"isSharedPortfolio":{"type":"number","description":"Shows if the portfolio is shared with other users or not. 1 means the portfolio is shared.","example":1}}}},"sharedPortfolios":{"type":["array","null"],"items":{"properties":{"portfolioId":{"type":"number","description":"A unique ID assigned to each portfolio.","example":131318},"name":{"type":"string","description":"A name of the portfolio","example":"Customers 2"}}}}}}}}},"components/schemas/ConnectMonitoringCreatePortfolioRequest":{"id":"components/schemas/ConnectMonitoringCreatePortfolioRequest","kind":"json-schema","title":"ConnectMonitoringCreatePortfolioRequest","data":{"type":"object","properties":{"name":{"type":"string","description":"The name of the portfolio","example":"Test Portfolio"},"isDefault":{"type":"boolean","description":"can set the portfolio as default for company monitoring events.","example":false},"emails":{"type":"array","description":"The email address of the user to receive the email notification.","items":{"properties":{"firstName":{"type":"string","description":"The first name of the user to receive the email notification.","example":"John"},"lastName":{"type":"string","description":"The last name of the user to receive the email notification.","example":"Doe"},"emailAddress":{"type":"string","description":"The email address of the user to receive the email notification.","example":"john.doe@creditsafe.com"}}}},"emailSubject":{"type":"string","description":"The subject of the email notification.","example":"Creditsafe Monitoring Notification on portfolio {{portfolioName}}"},"emailLanguage":{"type":"string","description":"The language of the email notification.","example":"en"},"frequency":{"type":"string","description":"The frequency property must be set to \"1\" to activate email notifications.","example":"1"}},"required":["name"]}},"components/schemas/ConnectMonitoringCreatePortfolioResponse":{"id":"components/schemas/ConnectMonitoringCreatePortfolioResponse","kind":"json-schema","title":"ConnectMonitoringCreatePortfolioResponse","data":{"type":"object","properties":{"correlationId":{"type":"string","description":"A unique ID assigned to this request.","example":"14cc64a0-c108-11ea-b9af-06bcc69a383e"},"portfolioId":{"type":"number","description":"A unique ID assigned to each portfolio.","example":131318},"name":{"type":"string","description":"The name that was assigned to this portfolio","example":"My New Portfolio"},"isDefault":{"type":"boolean","description":"Shows if the portfolio is set as Default for the user.","example":false}}}},"components/schemas/ConnectMonitoringGetPortfolioById":{"id":"components/schemas/ConnectMonitoringGetPortfolioById","kind":"json-schema","title":"ConnectMonitoringGetPortfolioById","data":{"type":"object","properties":{"correlationId":{"type":"string","description":"A unique ID assigned to this request.","example":"23921650-c073-11ea-860f-06bc8182190e"},"portfolioId":{"type":"number","description":"A unique ID assigned to each portfolio.","example":36},"name":{"type":"string","description":"The name of the portfolio","example":"Customers 2"},"isDefault":{"type":"boolean","description":"States if the portfolio is set as Default or not","example":false},"emailSubject":{"type":"string","description":"The subject of the email notification.","example":"Creditsafe Monitoring Notification on portfolio {{portfolioName}}"},"emails":{"type":"array","description":"The email addresses of the user to receive the email notification.","items":{"properties":{"firstName":{"type":"string","description":"The first name of the user to receive the email notification.","example":"John"},"lastName":{"type":"string","description":"The last name of the user to receive the email notification.","example":"Doe"},"emailAddress":{"type":"string","description":"The email address of the user to receive the email notification.","example":"john.doe@creditsafe.com"}}}}}}},"components/schemas/ConnectMonitoringDeletePortfolio":{"id":"components/schemas/ConnectMonitoringDeletePortfolio","kind":"json-schema","title":"ConnectMonitoringDeletePortfolio","data":{"type":"object","properties":{"message":{"type":"string","description":"Message stating if your request was successful","example":"Portfolio removed and service usage will be updated shortly"}}}},"components/schemas/ConnectMonitoringUpdatePortfolioRequestEmail":{"id":"components/schemas/ConnectMonitoringUpdatePortfolioRequestEmail","kind":"json-schema","title":"ConnectMonitoringUpdatePortfolioRequestEmail","data":{"type":"object","properties":{"firstName":{"type":"string","description":"The first name of the user to receive the email notification."},"lastName":{"type":"string","description":"The last name of the user to receive the email notification."},"emailAddress":{"type":"string","description":"The email address of the user to receive the email notification."}},"required":["emailAddress"]}},"components/schemas/ConnectMonitoringUpdatePortfolioRequest":{"id":"components/schemas/ConnectMonitoringUpdatePortfolioRequest","kind":"json-schema","title":"ConnectMonitoringUpdatePortfolioRequest","data":{"type":"object","properties":{"name":{"type":"string","description":"The name of the portfolio"},"isDefault":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Change the setting of the portfolio as default for company monitoring events."},"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":" Changing the default portfolio will automatically change the status of the previous default to 'false'."},"children":[]}]}]}]},"emails":{"type":"array","description":"The email addresses of the user to receive the email notification.","items":{"$ref":"#/components/schemas/ConnectMonitoringUpdatePortfolioRequestEmail"}},"emailSubject":{"type":"string","description":"The subject of the email notification."},"emailLanguage":{"type":"string","description":"The language of the email notification."},"frequency":{"type":"string","description":"For emails to be activated you must submit a value of '1'"}},"required":["name"]}},"components/schemas/ConnectMonitoringCompaniesInAPortfolio":{"id":"components/schemas/ConnectMonitoringCompaniesInAPortfolio","kind":"json-schema","title":"ConnectMonitoringCompaniesInAPortfolio","data":{"type":"object","properties":{"correlationId":{"type":"string","description":"A unique ID assigned to this request.","example":"23921650-c073-11ea-860f-06bc8182190e"},"totalCount":{"type":"number","description":"The total number of companies returned for the given portfolio.","example":1},"paging":{"$ref":"#/components/schemas/ConnectMonitoringPaging"},"data":{"type":"array","items":{"properties":{"id":{"type":"string","description":"The connectId of the company. A connectId is the primary Company identifier that is used to uniquely identify all companies across Creditsafe's Universe and Partner Network.","example":"US-X-US22384484"},"safeNumber":{"type":"string","description":"The Safe Number (Creditsafe's identifier on all Companies owned in the Creditsafe Universe) of the company.","example":"US22384484"},"name":{"type":"string","description":"The name of the company.","example":"GOOGLE LLC"},"address":{"type":"string","description":"The address of the company.","example":"VIA PABLO NERUDA, 4, TREZZANO SUL NAVIGLIO, 20090"},"countryCode":{"type":"string","description":"ISO/Alpha 2 format country code of the company.","example":"US"},"portfolioId":{"type":"number","description":"The portfolio Id of the portfolio that contains the company.","example":589960},"creditLimit":{"type":["number","null"],"description":"The credit limit of the company.","example":10000},"dateLastEvent":{"type":["string","null"],"description":"The date of the most recent event the company has had.","example":"2018-06-14T00:59:06"},"freeText":{"type":["string","null"],"description":"Field that can be used to add a free text note to when adding a company to a portfolio.","example":null},"personalLimit":{"type":["string","null"],"description":"Field that can be used to add a personal limit number against the company in a portfolio.","example":"10000"},"personalReference":{"type":["string","null"],"description":"Field that can be used to add a personal reference against the company in a portfolio.","example":"Follow up Jan 2021"},"ratingCommon":{"type":["string","null"],"description":"The rating score band that the company is in.","example":"A"},"ratingLocal":{"type":["string","null"],"description":"Country specific rating score.","example":"Not rated - insufficient information to rate"},"companyStatus":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In the Company status indicator."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Regional models differ, so 2 may represent Pending or Inactive."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1 (Active)"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2 (Pending/Inactive)"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3 (Inactive)"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"null (Unknown)"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For full details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://doc.creditsafe.com/connect-apis-catalog/product-catalog/globalmonitoring/documentation/status"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Company Status Property"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"1"},"dateAdded":{"type":"string","format":"date-time"},"dateModified":{"type":"string","format":"date-time"}}}}}}},"components/schemas/ConnectMonitoringAddCompanyToPortfolioRequest":{"id":"components/schemas/ConnectMonitoringAddCompanyToPortfolioRequest","kind":"json-schema","title":"ConnectMonitoringAddCompanyToPortfolioRequest","data":{"type":"object","properties":{"id":{"type":"string","description":"The company Safe Number or Connect ID"},"personalReference":{"description":"A personal reference for the company","type":["string","null"]},"freeText":{"description":"A free field to add any additional text to the company in the portfolio","type":["string","null"]},"personalLimit":{"description":"A personal limit for the company - separate from the credit limit","type":["string","null"]}},"required":["id","personalReference","freeText","personalLimit"]}},"components/schemas/ConnectMonitoringAddCompanyToPortfolioResponse":{"id":"components/schemas/ConnectMonitoringAddCompanyToPortfolioResponse","kind":"json-schema","title":"ConnectMonitoringAddCompanyToPortfolioResponse","data":{"type":"object","properties":{"correlationId":{"type":"string","description":"A unique ID assigned to this request.","example":"23921650-c073-11ea-860f-06bc8182190e"},"message":{"type":"string","description":"A status message relating to your request.","example":"Company Added"}}}},"components/schemas/ConnectMonitoringGetCompanyFromPortfolio":{"id":"components/schemas/ConnectMonitoringGetCompanyFromPortfolio","kind":"json-schema","title":"ConnectMonitoringGetCompanyFromPortfolio","data":{"type":"object","properties":{"correlationId":{"type":"string","description":"A unique ID assigned to this request.","example":"23921650-c073-11ea-860f-06bc8182190e"},"connectId":{"type":"string","description":"The connectId of the company. A connectId is the primary Company identifier that is used to uniquely identify all companies across Creditsafe's Universe and Partner Network.","example":"US-X-US22384484"},"portfolioId":{"type":"number","description":"The portfolio Id of the portfolio that contains the company.","example":589960},"personalReference":{"type":["string","null"],"description":"Field that can be used to add a personal reference against the company in a portfolio.","example":"Follow up Jan 2021"},"freeText":{"type":["string","null"],"description":"Field that can be used to add a free text note to when adding a company to a portfolio.","example":null},"personalLimit":{"type":["string","null"],"description":"Field that can be used to add a personal limit number against the company in a portfolio.","example":"10000"},"safeNumber":{"type":"string","description":"The Safe Number (Creditsafe's identifier on all Companies owned in the Creditsafe Universe) of the company.","example":"US22384484"},"name":{"type":"string","description":"The name of the company .","example":"GOOGLE LLC"},"countryCode":{"type":"string","description":"ISO/Alpha 2 format country code of the company.","example":"US"},"address":{"type":"string","description":"The address of the company.","example":"VIA PABLO NERUDA, 4, TREZZANO SUL NAVIGLIO, 20090"},"companyStatus":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In the Company status indicator."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Regional models differ, so 2 may represent Pending or Inactive."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1 (Active)"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2 (Pending/Inactive)"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3 (Inactive)"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"null (Unknown)"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For full details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://doc.creditsafe.com/connect-apis-catalog/product-catalog/globalmonitoring/documentation/status"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Company Status Property"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"1"},"creditLimit":{"type":["number","null"],"description":"The credit limit of the company.","example":10000},"ratingCommon":{"type":["string","null"],"description":"The rating score band that the company is in.","example":"A"},"ratingLocal":{"type":["string","null"],"description":"Country specific rating score.","example":"Not rated - insufficient information to rate"},"dateLastEvent":{"type":["string","null"],"format":"date-time","description":"The date of the most recent event the company has had.","example":"2018-06-14T00:59:06"},"dateAdded":{"type":["string","null"],"format":"date-time","description":"The date the company was added to the portfolio.","example":"2020-07-01T00:59:06"},"dateModified":{"type":["string","null"],"format":"date-time","description":"The date the company was last modified in the portfolio.","example":"2020-07-01T00:59:06"}}}},"components/schemas/ConnectMonitoringDeleteCompanyFromPortfolio":{"id":"components/schemas/ConnectMonitoringDeleteCompanyFromPortfolio","kind":"json-schema","title":"ConnectMonitoringDeleteCompanyFromPortfolio","data":{"type":"object","properties":{"correlationId":{"type":"string","description":"A unique ID assigned to this request.","example":"23921650-c073-11ea-860f-06bc8182190e"},"message":{"type":"string","description":"A message stating successful deletion.","example":"Company removed"}}}},"components/schemas/ConnectMonitoringUpdateCompanyDetailsInPortfolioRequest":{"id":"components/schemas/ConnectMonitoringUpdateCompanyDetailsInPortfolioRequest","kind":"json-schema","title":"ConnectMonitoringUpdateCompanyDetailsInPortfolioRequest","data":{"type":"object","properties":{"personalReference":{"description":"Field that can be used to add a personal reference against the company in a portfolio.","type":"string"},"freeText":{"description":"Field that can be used to add a free text note to when adding/updating a company to a portfolio.","type":"string"},"personalLimit":{"description":"Field that can be used to add a personal limit number against the company in a portfolio. This needs to be a positive number but in string format.","type":"string"}},"required":["personalReference","freeText","personalLimit"]}},"components/schemas/ConnectMonitoringUpdateCompanyInPortfolio":{"id":"components/schemas/ConnectMonitoringUpdateCompanyInPortfolio","kind":"json-schema","title":"ConnectMonitoringUpdateCompanyInPortfolio","data":{"type":"object","properties":{"correlationId":{"type":"string","description":"A unique ID assigned to this request.","example":"23921650-c073-11ea-860f-06bc8182190e"},"message":{"type":"string","description":"A message stating successful update.","example":"Company updated successfully"}}}},"components/schemas/ConnectMonitoringClearCompaniesRequest":{"id":"components/schemas/ConnectMonitoringClearCompaniesRequest","kind":"json-schema","title":"ConnectMonitoringClearCompaniesRequest","data":{"type":"object","properties":{"companies":{"type":"array","items":{"type":"string"}}},"description":"Comma separated Company Safe Number or Connect ID. Not required when copyAll query parameter is set to true."}},"components/schemas/ConnectMonitoringClearCompaniesResponse":{"id":"components/schemas/ConnectMonitoringClearCompaniesResponse","kind":"json-schema","title":"ConnectMonitoringClearCompaniesResponse","data":{"type":"object","properties":{"correlationId":{"type":"string","description":"A unique ID assigned to this request.","example":"23921650-c073-11ea-860f-06bc8182190e"},"message":{"type":"string","description":"A message stating if your request was successful.","example":"Companies deleted from portfolio"}}}},"components/schemas/ConnectMonitoringCopyAndMoveCompaniesBodyCompanies":{"id":"components/schemas/ConnectMonitoringCopyAndMoveCompaniesBodyCompanies","kind":"json-schema","title":"ConnectMonitoringCopyAndMoveCompaniesBodyCompanies","data":{"type":"object","properties":{"id":{"type":"string","description":"Company Safe Number or Connect ID. Not required when copyAll query parameter is set to true."}}}},"components/schemas/ConnectMonitoringCopyAndMoveCompaniesRequest":{"id":"components/schemas/ConnectMonitoringCopyAndMoveCompaniesRequest","kind":"json-schema","title":"ConnectMonitoringCopyAndMoveCompaniesRequest","data":{"type":"object","properties":{"portfolios":{"description":"Comma separated portfolioId(s).","type":"array","items":{"type":"integer","description":"Comma separated portfolioId(s)"}},"companies":{"description":"Array of companies to copy.","type":"array","items":{"$ref":"#/components/schemas/ConnectMonitoringCopyAndMoveCompaniesBodyCompanies"}}},"required":["portfolios"]}},"components/schemas/ConnectMonitoringCopyAndMoveCompaniesResponse":{"id":"components/schemas/ConnectMonitoringCopyAndMoveCompaniesResponse","kind":"json-schema","title":"ConnectMonitoringCopyAndMoveCompaniesResponse","data":{"type":"object","properties":{"correlationId":{"type":"string","description":"A unique ID assigned to this request.","example":"23921650-c073-11ea-860f-06bc8182190e"},"data":{"type":"object","properties":{"totalPortfoliosCompanies":{"type":"integer","description":"Total amount of companies attempted to copy.","example":5},"successfulPortfoliosCompanies":{"type":"integer","description":"Amount of companies successfully copied.","example":3},"failedPortfoliosCompanies":{"type":"integer","description":"Amount of companies successfully copied.","example":2},"reason":{"type":"string","description":"A message with a reason for why there was failures.","example":"Duplicate entry '199483-FR00002855' for key 'PRIMARY"}}}}}},"components/schemas/ConnectMonitoringMonitoredCountriesInPortfolio":{"id":"components/schemas/ConnectMonitoringMonitoredCountriesInPortfolio","kind":"json-schema","title":"ConnectMonitoringMonitoredCountriesInPortfolio","data":{"type":"array","items":{"type":"string"},"example":["FR","LU","DE"]}},"components/schemas/ConnectMonitoringListPortfolioEventRules":{"id":"components/schemas/ConnectMonitoringListPortfolioEventRules","kind":"json-schema","title":"ConnectMonitoringListPortfolioEventRules","data":{"type":"array","items":{"type":"object","properties":{"isActive":{"type":"boolean","description":"Shows whether the notification event rule has been enabled for the given portfolio.","example":0},"ruleCode":{"type":"number","description":"The unique identifier for the notification event rule.","example":101},"ruleCountryCode":{"type":"string","description":"The ISO/Alpha 2 format country code for the notification event rule. \"XX\" is used for global rules that apply to companies from all countries.","example":"XX"},"ruleType":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ruleType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the notification event rule."},"children":[]}]}]}],"example":4},"ruleTypeName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A short description of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ruleType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the notification event rule."},"children":[]}]}]}],"example":"Rating band change - 3 input"},"name":{"type":"string","description":"The name for the notification event rule.","example":"International Rating | Reduce by {0} Band(s) OR Less than Band {1}"},"param0":{"type":"string","description":"Some notification event rules may include input parameters used to tailor the notifications generated to your preference.","example":"1"},"param1":{"type":"string","description":"Some notification event rules may include input parameters used to tailor the notifications generated to your preference.","example":"A"},"param2":{"type":"boolean","description":"Some notification event rules may include input parameters used to tailor the notifications generated to your preference.","example":true}}}}},"components/schemas/ConnectMonitoringUpdateEventRulesBody":{"id":"components/schemas/ConnectMonitoringUpdateEventRulesBody","kind":"json-schema","title":"ConnectMonitoringUpdateEventRulesBody","data":{"type":"object","properties":{"ruleCode":{"type":"integer","description":"The unique ID of the EventRule."},"isActive":{"type":"integer","description":"Flag to show if EventRule is active or not. 0 for false, 1 for true."},"param0":{"anyOf":[{"type":"string"},{"type":"integer"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional parameter used by some rules. Each rule type may use this property differently.   For special event rules, consult the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://doc.creditsafe.com/connect-apis-catalog/product-catalog/globalmonitoring/documentation/specialeventrules"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Special Event Rules documentation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":".   For other rules, use the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://doc.creditsafe.com/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/individual-portfolio-management/listportfolioeventrules"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List Portfolio Event Rules endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to see available options."},"children":[]}]}]}]},"param1":{"anyOf":[{"type":"string"},{"type":"integer"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional parameter used by some rules. Each rule type may use this property differently.   For special event rules, consult the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://doc.creditsafe.com/connect-apis-catalog/product-catalog/globalmonitoring/documentation/specialeventrules"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Special Event Rules documentation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":".   For other rules, use the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://doc.creditsafe.com/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/individual-portfolio-management/listportfolioeventrules"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List Portfolio Event Rules endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to see available options."},"children":[]}]}]}]},"param2":{"anyOf":[{"type":"string"},{"type":"integer"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional parameter used by some rules. Each rule type may use this property differently.   For special event rules, consult the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://doc.creditsafe.com/connect-apis-catalog/product-catalog/globalmonitoring/documentation/specialeventrules"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Special Event Rules documentation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":".   For other rules, use the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://doc.creditsafe.com/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/individual-portfolio-management/listportfolioeventrules"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List Portfolio Event Rules endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to see available options."},"children":[]}]}]}]}},"required":["ruleCode","isActive"]}},"components/schemas/ConnectMonitoringUpdateEventRulesRequest":{"id":"components/schemas/ConnectMonitoringUpdateEventRulesRequest","kind":"json-schema","title":"ConnectMonitoringUpdateEventRulesRequest","data":{"type":"array","items":{"$ref":"#/components/schemas/ConnectMonitoringUpdateEventRulesBody"}}},"components/schemas/ConnectMonitoringImportAndSyncPortfolioRequest":{"id":"components/schemas/ConnectMonitoringImportAndSyncPortfolioRequest","kind":"json-schema","title":"ConnectMonitoringImportAndSyncPortfolioRequest","data":{"type":"object","properties":{"importcsv":{"type":"string","format":"binary","description":"The import file ideally needs to be a .csv file."},"email":{"type":"string","description":"Option field. Provide an email and get a notification when the import has been completed with the details about the import.","example":"john.smith@creditsafe.com"}}}},"components/schemas/ConnectMonitoringImportAndSyncPortfolioResponse":{"id":"components/schemas/ConnectMonitoringImportAndSyncPortfolioResponse","kind":"json-schema","title":"ConnectMonitoringImportAndSyncPortfolioResponse","data":{"type":"object","properties":{"correlationId":{"type":"string","description":"A unique ID assigned to this request.","example":"23921650-c073-11ea-860f-06bc8182190e"},"status":{"type":"string","description":"A message about the status of this request.","example":"Accepted for processing. Import Id 339523"}}}},"components/schemas/ConnectMonitoringNotificationsEventsDataByDay":{"id":"components/schemas/ConnectMonitoringNotificationsEventsDataByDay","kind":"json-schema","title":"ConnectMonitoringNotificationsEventsDataByDay","data":{"type":"object","properties":{"totalCount":{"type":"number","description":"The total number of events returned for the given company.","example":36},"data":{"type":"array","items":{"properties":{"dataDate":{"type":"string","format":"date-time","description":"The date that the event occurred.","example":"2019-12-06T08:23:37Z"},"dataValue":{"type":"integer","description":"The total number of events that occurred on the given date.","example":3}}}},"paging":{"type":"object","description":"Paging parameters.","properties":{"size":{"type":["number","null"],"description":"The maximum number of results returned per page.","example":null},"prev":{"type":["number","null"],"description":"The page number of the previous page, null if there is no previous page available.","example":null},"next":{"type":["number","null"],"description":"The page number of the next page, null if there is no next page available.","example":null},"last":{"type":["number","null"],"description":"The page number of the last page.","example":null}}}}}},"components/schemas/ConnectMonitoringRiskSummary":{"id":"components/schemas/ConnectMonitoringRiskSummary","kind":"json-schema","title":"ConnectMonitoringRiskSummary","data":{"type":"object","properties":{"correlationId":{"type":"string","description":"A unique ID assigned to this request.","example":"23921650-c073-11ea-860f-06bc8182190e"},"totalCompanies":{"type":"number","description":"Total Companies in the portfolio","example":66},"bandACount":{"type":"number","example":20},"bandApc":{"type":"number","example":40.625},"bandBCount":{"type":"number","example":17},"bandBpc":{"type":"number","example":26.5625},"bandCCount":{"type":"number","example":14},"bandCpc":{"type":"number","example":21.8775},"bandDCount":{"type":"number","example":5},"bandDpc":{"type":"number","example":7.8125},"bandECount":{"type":"number","example":2},"bandEpc":{"type":"number","example":3.125}}}},"components/schemas/ConnectMonitoringListSharingPermissions":{"id":"components/schemas/ConnectMonitoringListSharingPermissions","kind":"json-schema","title":"ConnectMonitoringListSharingPermissions","data":{"type":"object","properties":{"correlationId":{"type":"string","description":"A unique ID assigned to this request.","example":"23921650-c073-11ea-860f-06bc8182190e"},"data":{"type":"object","properties":{"portfolioId":{"type":"string","description":"A unique ID assigned to each portfolio.","example":"13437356"},"customerId":{"type":"number","description":"A unique ID assigned to your customer account.","example":101375376},"userPermission":{"type":"array","items":{"type":"object","properties":{"csUserId":{"type":"number","description":"The unique ID assigned to the user account the portfolios are shared with.","example":101435674},"userName":{"type":"string","description":"The username of the user.","example":"UPPStage"},"permission":{"type":"string","description":"The permissions this user has for this portfolio.","example":"View, Add, Remove"}}}}}}}}},"components/schemas/ConnectMonitoringSharePortfolioRequestBody":{"id":"components/schemas/ConnectMonitoringSharePortfolioRequestBody","kind":"json-schema","title":"ConnectMonitoringSharePortfolioRequestBody","data":{"type":"object","properties":{"csUserId":{"type":"integer","description":"A creditsafe user id."},"permissions":{"type":"string","description":"Comma separated permissions. \"View\" permission gets automatically added to the user if \"Add\", \"Edit\", \"Remove\" permissions are set."}}}},"components/schemas/ConnectMonitoringSharePortfolioRequest":{"id":"components/schemas/ConnectMonitoringSharePortfolioRequest","kind":"json-schema","title":"ConnectMonitoringSharePortfolioRequest","data":{"type":"object","properties":{"revokeAll":{"type":"string","description":"If set to \"true\", all user permissions will be revoked for the portfolio. By default set to \"false\"."},"userPermissions":{"type":"array","items":{"$ref":"#/components/schemas/ConnectMonitoringSharePortfolioRequestBody"}}}}},"components/schemas/ConnectMonitoringSharePortfolioRequestResponse":{"id":"components/schemas/ConnectMonitoringSharePortfolioRequestResponse","kind":"json-schema","title":"ConnectMonitoringSharePortfolioRequestResponse","data":{"type":"object","properties":{"correlationId":{"type":"string","description":"A unique ID assigned to this request.","example":"23921650-c073-11ea-860f-06bc8182190e"},"data":{"type":"object","properties":{"portfolioId":{"type":"string","description":"A unique ID assigned to each portfolio.","example":"13437356"},"customerId":{"type":"number","description":"A unique ID assigned to your customer account.","example":101375376},"status":{"type":"string","description":"A message about the status of this request.","example":"Success"}}}}}},"components/schemas/ConnectMonitoringUserDetails":{"id":"components/schemas/ConnectMonitoringUserDetails","kind":"json-schema","title":"ConnectMonitoringUserDetails","data":{"type":"array","items":{"properties":{"countryCode":{"type":"string","example":"US","description":"The ISO/Alpha 2 format country code for the user's country."},"createdDate":{"type":"string","format":"date-time","example":"2020-01-01T00:00:00","description":"The date that the Global Monitoring user account was created."},"csCustomerId":{"type":"number","example":101662701,"description":"The unique identifier for the user's customer account, used across the Creditsafe product suite."},"csUserId":{"type":"number","example":101445010,"description":"The unique identifier for the user's account, used across the Creditsafe product suite."},"isAutoTracker":{"type":"boolean","example":false,"description":"If auto-tracker is enabled, any companies that you pull a credit report for are automatically added to the portfolio that you have selected as default."},"languageCode":{"type":"string","example":"en","description":"The language code for the user's preferred language."},"lastAccessDate":{"type":["string","null"],"format":"date-time","example":"2020-02-01T14:30:00","description":"The date the the user last accessed the Global Monitoring product."},"modifiedDate":{"type":["string","null"],"format":"date-time","example":"2020-02-01T14:30:00","description":"The date that the user's details were last modified."},"contractEndDate":{"type":["string","null"],"format":"date-time","example":"2021-01-01T00:00:00","description":"The date that the user's contract is currently set to expire. From this date onward, the user will be unable to access to Global Monitoring product."},"userId":{"type":"number","example":10804,"description":"The internal identifier used to reference the user's account through the Global Monitoring product."}}}}},"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/CreditsafeGlobalDataReportsDirectorsDirectorSummary":{"id":"components/schemas/CreditsafeGlobalDataReportsDirectorsDirectorSummary","kind":"json-schema","title":"CreditsafeGlobalDataReportsDirectorsDirectorSummary","data":{"type":"object","properties":{"currentAppointments":{"type":"integer","format":"int32"},"inactiveAppointments":{"type":"integer","format":"int32"},"previousAppointments":{"type":"integer","format":"int32"}}}},"components/schemas/CreditsafeGlobalDataReportsDirectorsDirectorshipAdditionalData":{"id":"components/schemas/CreditsafeGlobalDataReportsDirectorsDirectorshipAdditionalData","kind":"json-schema","title":"CreditsafeGlobalDataReportsDirectorsDirectorshipAdditionalData","data":{"allOf":[{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsAdditionalData"},{"type":"object"}]}},"components/schemas/CreditsafeGlobalDataReportsDirectorsDirectorship":{"id":"components/schemas/CreditsafeGlobalDataReportsDirectorsDirectorship","kind":"json-schema","title":"CreditsafeGlobalDataReportsDirectorsDirectorship","data":{"type":"object","properties":{"id":{"type":"string"},"idType":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsIdType"},"companyName":{"type":"string"},"companyNumber":{"type":"string"},"companyRegistrationNumber":{"type":"string"},"address":{"$ref":"#/components/schemas/CreditsafeGlobalDataAddressData"},"status":{"$ref":"#/components/schemas/CreditsafeGlobalDataCompanyStatus"},"activity":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsCompanyActivity"},"position":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsCorporatePositionResigned"},"signingAuthority":{"type":["boolean","null"]},"companyRegistrationDate":{"type":["string","null"],"format":"date-time"},"legalForm":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsLegalForm"},"state":{"type":"string"},"yearEndDate":{"type":["string","null"],"format":"date-time"},"currency":{"$ref":"#/components/schemas/CreditsafeGlobalDataCurrency"},"latestTurnoverFigure":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsFinancialValue_1_SystemDecimal"},"netWorth":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsFinancialValue_1_SystemDecimal"},"legalCount":{"type":["integer","null"],"format":"int32"},"legalAmount":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsFinancialValue_1_SystemDecimal"},"legalCountInLast12Months":{"type":["integer","null"],"format":"int32"},"creditScore":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsLtdCreditScore"},"dbt":{"type":["number","null"],"format":"double"},"additionalData":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsDirectorsDirectorshipAdditionalData"}}}},"components/schemas/CreditsafeGlobalDataReportsDirectorsDirectorships":{"id":"components/schemas/CreditsafeGlobalDataReportsDirectorsDirectorships","kind":"json-schema","title":"CreditsafeGlobalDataReportsDirectorsDirectorships","data":{"type":"object","properties":{"current":{"type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsDirectorsDirectorship"}},"previous":{"type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsDirectorsDirectorship"}},"inactive":{"type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsDirectorsDirectorship"}}}}},"components/schemas/CreditsafeGlobalDataReportsDirectorsDirectorReport":{"id":"components/schemas/CreditsafeGlobalDataReportsDirectorsDirectorReport","kind":"json-schema","title":"CreditsafeGlobalDataReportsDirectorsDirectorReport","data":{"type":"object","properties":{"directorId":{"type":"string"},"directorSummary":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsDirectorsDirectorSummary"},"directorDetails":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsDirector"},"otherAddresses":{"type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataAddressData"}},"directorships":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsDirectorsDirectorships"}}}},"components/schemas/CreditsafeGlobalDataReportsDirectorsDirectorReportResponse":{"id":"components/schemas/CreditsafeGlobalDataReportsDirectorsDirectorReportResponse","kind":"json-schema","title":"CreditsafeGlobalDataReportsDirectorsDirectorReportResponse","data":{"allOf":[{"$ref":"#/components/schemas/CreditsafeGlobalDataServiceResponse"},{"type":"object","properties":{"report":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsDirectorsDirectorReport"}}}]}},"components/schemas/CreditsafeGlobalDataSearchCriteriaSchemaDirector":{"id":"components/schemas/CreditsafeGlobalDataSearchCriteriaSchemaDirector","kind":"json-schema","title":"CreditsafeGlobalDataSearchCriteriaSchemaDirector","data":{"allOf":[{"$ref":"#/components/schemas/CreditsafeGlobalDataSearchCriteriaSchemaBase"},{"type":"object","properties":{"id":{"$ref":"#/components/schemas/CreditsafeGlobalDataSearchCriteriaSchema-ValueSchema_1_SystemString"},"firstName":{"$ref":"#/components/schemas/CreditsafeGlobalDataSearchCriteriaSchema-QueryStringSchema"},"lastName":{"$ref":"#/components/schemas/CreditsafeGlobalDataSearchCriteriaSchema-QueryStringSchema"},"companyId":{"$ref":"#/components/schemas/CreditsafeGlobalDataSearchCriteriaSchema-ValueSchema_1_SystemString"},"companyName":{"$ref":"#/components/schemas/CreditsafeGlobalDataSearchCriteriaSchema-QueryStringSchema"},"companyType":{"$ref":"#/components/schemas/CreditsafeGlobalDataSearchCriteriaSchema-ValueSchema_1_CreditsafeGlobalDataCompanyType"},"companyRegistrationNumber":{"$ref":"#/components/schemas/CreditsafeGlobalDataSearchCriteriaSchema-ValueSchema_1_SystemString"},"address":{"$ref":"#/components/schemas/CreditsafeGlobalDataAddressCriteriaSchema"},"status":{"$ref":"#/components/schemas/CreditsafeGlobalDataSearchCriteriaSchema-ValueSchema_1_SystemString"}}}]}},"components/schemas/CreditsafeGlobalDataSearchCriteriaSchemaCountryDirector":{"id":"components/schemas/CreditsafeGlobalDataSearchCriteriaSchemaCountryDirector","kind":"json-schema","title":"CreditsafeGlobalDataSearchCriteriaSchemaCountryDirector","data":{"type":"object","properties":{"country":{"$ref":"#/components/schemas/CreditsafeGlobalDataCountryCode"},"schemas":{"type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataSearchCriteriaSchemaDirector"}}}}},"components/schemas/CreditsafeGlobalDataCustomDataEntrySchema":{"id":"components/schemas/CreditsafeGlobalDataCustomDataEntrySchema","kind":"json-schema","title":"CreditsafeGlobalDataCustomDataEntrySchema","data":{"type":"object","properties":{"key":{"type":"string"},"optional":{"type":"boolean"},"allowedValues":{"type":"array","items":{"type":"string"}},"description":{"type":"string"}}}},"components/schemas/CreditsafeGlobalDataSearchCriteriaSchemaSetDirector":{"id":"components/schemas/CreditsafeGlobalDataSearchCriteriaSchemaSetDirector","kind":"json-schema","title":"CreditsafeGlobalDataSearchCriteriaSchemaSetDirector","data":{"allOf":[{"$ref":"#/components/schemas/CreditsafeGlobalDataServiceResponse"},{"type":"object","properties":{"countriesCriteria":{"description":"The list of available parameters for the search in the given country.","type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataSearchCriteriaSchemaCountryDirector"}},"customData":{"type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataCustomDataEntrySchema"}}}}]}},"components/schemas/ConnectProtectAuditDto":{"id":"components/schemas/ConnectProtectAuditDto","kind":"json-schema","title":"ConnectProtectAuditDto","data":{"type":"object","properties":{"id":{"type":"string","format":"guid"},"description":{"type":"string"},"type":{"type":"string"},"userId":{"type":"string"},"payload":{"type":"object","additionalProperties":{"type":"object"}},"createdAt":{"type":"string","format":"date-time"}}}},"components/schemas/ConnectProtectAuditExportPayloadDto":{"id":"components/schemas/ConnectProtectAuditExportPayloadDto","kind":"json-schema","title":"ConnectProtectAuditExportPayloadDto","data":{"type":"object","properties":{"profileId":{"type":"string","format":"guid"},"investigationId":{"type":"string","format":"guid"}}}},"components/schemas/ConnectProtectAuditExportRequestDto":{"id":"components/schemas/ConnectProtectAuditExportRequestDto","kind":"json-schema","title":"ConnectProtectAuditExportRequestDto","data":{"required":["fileType"],"type":"object","properties":{"fileType":{"type":"string","enum":["csv"]},"auditType":{"type":"string","enum":["alert.accepted","alert.rejected","alert.received","profile.added","profile.created","investigation.accepted","investigation.created","investigation.file_downloaded","schedule.created","schedule.removed"]},"userId":{"type":"integer","format":"int32"},"keywordSearch":{"type":"string"},"createdAtOrAfter":{"type":"string","format":"date-time"},"createdAtOrBefore":{"type":"string","format":"date-time"},"payload":{"$ref":"#/components/schemas/ConnectProtectAuditExportPayloadDto"}}}},"components/schemas/ConnectProtectAuditsExportResponseDto":{"id":"components/schemas/ConnectProtectAuditsExportResponseDto","kind":"json-schema","title":"ConnectProtectAuditsExportResponseDto","data":{"type":"object","properties":{"location":{"type":"string","format":"uri"}}}},"components/schemas/ConnectProtectProblemDetails":{"id":"components/schemas/ConnectProtectProblemDetails","kind":"json-schema","title":"ConnectProtectProblemDetails","data":{"type":"object","properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"integer","format":"int32"},"detail":{"type":"string"},"instance":{"type":"string"},"extensions":{"type":"object","additionalProperties":{"type":"object"}}}}},"components/schemas/IdvRequestDto":{"id":"components/schemas/IdvRequestDto","kind":"json-schema","title":"IdvRequestDto","data":{"required":["address","country","dateOfBirth","id","name"],"type":"object","properties":{"name":{"type":"string"},"dateOfBirth":{"type":"string","format":"date-time"},"address":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"country":{"type":"string"},"postalCode":{"type":"string"},"acceptCulture":{"type":"string"},"id":{"type":"string","format":"guid"}}}},"components/schemas/MatchRate":{"id":"components/schemas/MatchRate","kind":"json-schema","title":"MatchRate","data":{"type":"string","description":"","enum":["fullMatch","partialMatch","noMatch"]}},"components/schemas/IdvSourcesDto":{"id":"components/schemas/IdvSourcesDto","kind":"json-schema","title":"IdvSourcesDto","data":{"required":["category","matchType"],"type":"object","properties":{"category":{"type":"string"},"matchType":{"type":"string"}}}},"components/schemas/IdvResponseDto":{"id":"components/schemas/IdvResponseDto","kind":"json-schema","title":"IdvResponseDto","data":{"required":["address","country","dateOfBirth","fullName","id","idvSearchId","matchRate","sources"],"type":"object","properties":{"matchRate":{"$ref":"#/components/schemas/MatchRate"},"fullName":{"type":"string"},"dateOfBirth":{"type":"string","format":"date-time"},"address":{"type":"string"},"country":{"type":"string"},"sources":{"type":"array","items":{"$ref":"#/components/schemas/IdvSourcesDto"}},"id":{"type":"string","format":"guid"},"idvSearchId":{"type":"string","format":"guid"}}}},"schema_387":{"kind":"json-schema","data":{"type":"string"},"id":"schema_387"},"schema_388":{"kind":"json-schema","data":{"type":"integer"},"id":"schema_388"},"schema_389":{"kind":"json-schema","data":{"type":"string","default":"asc","enum":["asc","desc"]},"id":"schema_389"},"schema_390":{"kind":"json-schema","data":{"type":"string","enum":["Credit Approval","CS Decision Module","Demo","Credit Approval, CS Decision Module"]},"id":"schema_390"},"schema_391":{"kind":"json-schema","data":{"type":"string","enum":["friendlyName"]},"id":"schema_391"},"schema_392":{"kind":"json-schema","data":{"type":"boolean","default":false},"id":"schema_392"},"schema_393":{"kind":"json-schema","data":{"type":"string","example":"repoObj_0ed6a4aa_16e17d977e9_07ffb16e17d977e9"},"id":"schema_393"},"schema_394":{"kind":"json-schema","data":{"type":"string","example":"US001-X-US60521352"},"id":"schema_394"},"schema_395":{"kind":"json-schema","data":{"type":"string","example":"CREDITSAFE"},"id":"schema_395"},"schema_396":{"kind":"json-schema","data":{"type":"number","example":1},"id":"schema_396"},"schema_397":{"kind":"json-schema","data":{"type":"string","format":"date-time"},"id":"schema_397"},"schema_398":{"kind":"json-schema","data":{"type":"integer","default":1},"id":"schema_398"},"schema_399":{"kind":"json-schema","data":{"type":"string","example":"GB-0-03836192"},"id":"schema_399"},"schema_400":{"kind":"json-schema","data":{"type":"string","example":"SFC-1976"},"id":"schema_400"},"schema_401":{"kind":"json-schema","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The POST body should contain the User Data Fields for the decision tree you want to run obtained via the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/{guid}/userDataFields"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}],"example":{"productType":"Product A","isCustomer":"Yes","salesValue":197600}},"id":"schema_401"},"schema_402":{"kind":"json-schema","data":{"type":"object","properties":{"Access-Control-Allow-Origin":{"type":"string"}}},"id":"schema_402"},"schema_403":{"kind":"json-schema","data":{"type":"object","properties":{"message":{"type":"string","example":"Decision outcome updated successfully."}}},"id":"schema_403"},"schema_404":{"kind":"json-schema","data":{"type":"string","maxLength":2,"minLength":2},"id":"schema_404"},"schema_405":{"kind":"json-schema","data":{"type":"string","example":"28/04/1978"},"id":"schema_405"},"schema_406":{"kind":"json-schema","data":{"type":"object","properties":{"reportLanguages":{"type":"array","items":{"type":"string","example":"NL"}}}},"id":"schema_406"},"schema_407":{"kind":"json-schema","data":{"type":"string","enum":["CompanyReportResponse"]},"id":"schema_407"},"schema_408":{"kind":"json-schema","data":{"type":"string","pattern":"^([a-zA-Z\\\\s]+,)*[a-zA-Z\\\\s]+$"},"id":"schema_408"},"schema_409":{"kind":"json-schema","data":{"type":["string","null"],"default":null,"maxLength":2,"minLength":2},"id":"schema_409"},"schema_410":{"kind":"json-schema","data":{"type":["string","null"],"default":null},"id":"schema_410"},"schema_411":{"kind":"json-schema","data":{"type":["string","null"]},"id":"schema_411"},"schema_412":{"kind":"json-schema","data":{"type":["boolean","null"]},"id":"schema_412"},"schema_413":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/CreditsafeGlobalDataOfficeType"},{"type":"null"}]},"id":"schema_413"},"schema_414":{"kind":"json-schema","data":{"type":"array","items":{"type":["string","null"]}},"id":"schema_414"},"schema_415":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/CreditsafeGlobalDataCompanyStatus"},{"type":"null"}]},"id":"schema_415"},"schema_416":{"kind":"json-schema","data":{"$ref":"#/components/schemas/CreditsafeGlobalDataCompanyType"},"id":"schema_416"},"schema_417":{"kind":"json-schema","data":{"pattern":"^[a-zA-Z]{2}$","type":["string","null"],"default":"en"},"id":"schema_417"},"schema_418":{"kind":"json-schema","data":{"type":["string","null"],"default":"full"},"id":"schema_418"},"schema_419":{"kind":"json-schema","data":{"oneOf":[{"type":"string","title":"PDF","enum":["application/pdf"]},{"type":"string","title":"HTML","enum":["application/html"]},{"type":"string","title":"PDF + HTML","enum":["application/pdf+html"]},{"type":"string","title":"JSON + PDF","enum":["application/json+pdf"]},{"type":"string","title":"JSON + HTML","enum":["application/json+html"]}],"example":"application/pdf"},"id":"schema_419"},"schema_420":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/ConnectConfidenceMatchMatchResults"},{"$ref":"#/components/schemas/ConnectConfidenceMatchNoResults"}]},"id":"schema_420"},"schema_421":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/CreditsafeGlobalDataSearchResponse_1_CreditsafeGlobalDataDirectorSearchData"}]},"id":"schema_421"},"schema_422":{"kind":"json-schema","data":{"pattern":"^[a-zA-Z]{2}([0-9]{1,3})?[-]{1}[a-zA-Z0-9$]+$","type":"string"},"id":"schema_422"},"schema_423":{"kind":"json-schema","data":{"pattern":"^[a-zA-Z]{2}$","type":"string","default":"en"},"id":"schema_423"},"schema_424":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/AMLSearch"},{"$ref":"#/components/schemas/AMLMultiBureauSearch"},{"$ref":"#/components/schemas/ConsumerSearch"}]},"id":"schema_424"},"schema_425":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/ConnectIdentityConsumerSearchResult"},{"$ref":"#/components/schemas/ConnectIdentityMultiBureauAmlSearchResult"},{"$ref":"#/components/schemas/ConnectIdentityAmlSearchResult"}]},"id":"schema_425"},"schema_426":{"kind":"json-schema","data":{"type":"array","items":{"type":"string"},"example":["1:1:1_0"]},"id":"schema_426"},"schema_427":{"kind":"json-schema","data":{"type":["integer","null"],"format":"int32"},"id":"schema_427"},"schema_428":{"kind":"json-schema","data":{"type":"boolean"},"id":"schema_428"},"schema_429":{"kind":"json-schema","data":{"type":["array","null"],"items":{"$ref":"#/components/schemas/ConnectIdentityProduct"}},"id":"schema_429"},"schema_430":{"kind":"json-schema","data":{"type":["string","null"],"format":"date-time"},"id":"schema_430"},"schema_431":{"kind":"json-schema","data":{"type":"string","enum":["CompanyDetails","SearchCriteria"]},"id":"schema_431"},"schema_432":{"kind":"json-schema","data":{"type":"string","enum":["creationDate","lastStatusChangeDate","orderID","status"]},"id":"schema_432"},"schema_433":{"kind":"json-schema","data":{"type":"string","enum":["last","recent","none"],"default":"last"},"id":"schema_433"},"schema_434":{"kind":"json-schema","data":{"properties":{"message":{"type":"string","description":"Success response of updated fresh investigation.","example":"FreshInvestigation OrderId is being updated"}}},"id":"schema_434"},"schema_435":{"kind":"json-schema","data":{"type":"integer","format":"date-time"},"id":"schema_435"},"schema_436":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/basic"},{"$ref":"#/components/schemas/basicPlus"},{"$ref":"#/components/schemas/standard"}]},"id":"schema_436"},"schema_437":{"kind":"json-schema","data":{"type":"integer","default":0},"id":"schema_437"},"schema_438":{"kind":"json-schema","data":{"type":"number"},"id":"schema_438"},"schema_439":{"kind":"json-schema","data":{"properties":{"message":{"type":"string"}}},"id":"schema_439"},"schema_440":{"kind":"json-schema","data":{"type":"integer","default":50},"id":"schema_440"},"schema_441":{"kind":"json-schema","data":{"type":"boolean","enum":[true,false]},"id":"schema_441"},"schema_442":{"kind":"json-schema","data":{"type":"string","default":"companyName","enum":["companyName","countryCode","eventId","eventDate"]},"id":"schema_442"},"schema_443":{"kind":"json-schema","data":{"type":"string","default":"eventId","enum":["companyName","countryCode","eventId","eventDate"]},"id":"schema_443"},"schema_444":{"kind":"json-schema","data":{"type":"boolean","default":false,"enum":[false,true]},"id":"schema_444"},"schema_445":{"kind":"json-schema","data":{"type":"object","example":{"message":"Portfolio not found"}},"id":"schema_445"},"schema_446":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","example":"GB"}},"id":"schema_446"},"schema_447":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","example":"eur"}},"id":"schema_447"},"schema_448":{"kind":"json-schema","data":{"type":"string","enum":["trust","individual","soleTrader","company","plc","partnership","otherEntity"]},"id":"schema_448"},"schema_449":{"kind":"json-schema","data":{"type":"array","items":{"type":"string"}},"id":"schema_449"},"schema_450":{"kind":"json-schema","data":{"enum":["individual","business"],"type":"string"},"id":"schema_450"},"schema_451":{"kind":"json-schema","data":{"type":"string","format":"uuid"},"id":"schema_451"},"schema_452":{"kind":"json-schema","data":{"type":"object","properties":{"items":{"type":["array","null"],"items":{"$ref":"#/components/schemas/AddSearchContract"},"description":"The Request Items collection"}}},"id":"schema_452"},"schema_453":{"kind":"json-schema","data":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/PostKYCProtectSchedulesRequest"}}}},"id":"schema_453"},"schema_454":{"kind":"json-schema","data":{"type":"object","properties":{"items":{"type":"array","items":{"type":"string","format":"uuid"}}}},"id":"schema_454"},"schema_455":{"kind":"json-schema","data":{"type":"object","properties":{"id":{"type":"string","description":"The id of the schedule","format":"uuid"},"searchId":{"type":"string","description":"The id of the search that was being scheduled","format":"uuid"},"isEmailRequired":{"type":"boolean","description":"Indicates whether the schedule requires an email to be sent when the search is run"},"emailRecipients":{"type":"array","items":{"type":["string","null"]},"description":"The email recipients that the email should be sent to when the search is run"},"createdById":{"type":"integer","description":"The id of the user who created the schedule","format":"int32"},"createdAt":{"type":"string","description":"The time the schedule was created","format":"date-time"},"createdBy":{"type":"string","description":"The name of the user who created the schedule"},"modifiedById":{"type":"integer","description":"The id of the user who last modified the schedule","format":"int32"},"modifiedAt":{"type":"string","description":"The time the schedule was last modified","format":"date-time"},"modifiedBy":{"type":"string","description":"The name of the user who last modified the schedule"},"type":{"type":"string","description":"The type of the schedule, i.e. business or individual"},"name":{"type":["string","null"],"description":"The name used in the search criteria"},"firstName":{"type":["string","null"],"description":"The first name used in the search criteria"},"middleName":{"type":["string","null"],"description":"The middle name used in the search criteria"},"lastName":{"type":["string","null"],"description":"The last name used in the search criteria"},"gender":{"type":["string","null"],"description":"The gender used in the search criteria, i.e. male or female"},"dateOfBirth":{"type":["string","null"],"description":"The date of birth used in the search criteria","format":"date"},"countries":{"type":["array","null"],"items":{"type":"string"},"description":"The list of country codes used in the search criteria"},"threshold":{"type":"integer","description":"The threshold used in the search criteria","format":"int32"},"datasets":{"type":"array","items":{"type":"string"},"description":"The datasets used in the search criteria"},"sanctionBodies":{"type":["array","null"],"items":{"type":"integer"},"description":"Provided sanctionBodies for the search"},"pepTiers":{"type":["array","null"],"items":{"type":"string"},"description":"The pep tiers used in the search criteria, i.e. pepTier1, pepTier2, pepTier3"},"isDobRequired":{"type":["boolean","null"],"description":"Indicates whether date of birth is required for the individual search.","default":true}}},"id":"schema_455"},"schema_456":{"kind":"json-schema","data":{"type":"object","properties":{"id":{"type":"string","description":"The id of the schedule","format":"uuid"},"searchId":{"type":"string","description":"The id of the search that was being scheduled","format":"uuid"},"isEmailRequired":{"type":"boolean","description":"Indicates whether the schedule requires an email to be sent when the search is run"},"emailRecipients":{"type":["array","null"],"items":{"type":"string"},"description":"The email recipients that the email should be sent to when the search is run"},"createdById":{"type":"integer","description":"The id of the user who created the schedule","format":"int32"},"createdAt":{"type":"string","description":"The time the schedule was created","format":"date-time"},"createdBy":{"type":"string","description":"The name of the user who created the schedule"},"modifiedById":{"type":"integer","description":"The id of the user who last modified the schedule","format":"int32"},"modifiedAt":{"type":"string","description":"The time the schedule was last modified","format":"date-time"},"modifiedBy":{"type":"string","description":"The name of the user who last modified the schedule"},"type":{"type":"string","description":"The type of the schedule, i.e. business or individual"},"name":{"type":["string","null"],"description":"The name used in the search criteria"},"firstName":{"type":["string","null"],"description":"The first name used in the search criteria"},"middleName":{"type":["string","null"],"description":"The middle name used in the search criteria"},"lastName":{"type":["string","null"],"description":"The last name used in the search criteria"},"gender":{"type":["string","null"],"description":"The gender used in the search criteria, i.e. male or female"},"dateOfBirth":{"type":["string","null"],"description":"The date of birth used in the search criteria","format":"date"},"countries":{"type":["array","null"],"items":{"type":"string"},"description":"The list of country codes used in the search criteria"},"threshold":{"type":"integer","description":"The threshold used in the search criteria","format":"int32"},"datasets":{"type":"array","items":{"type":"string"},"description":"The datasets used in the search criteria"},"pepTiers":{"type":["array","null"],"items":{"type":"string"},"description":"The pep tiers used in the search criteria, i.e. pepTier1, pepTier2, pepTier3, byAssociation"},"isDobRequired":{"type":["boolean","null"],"description":"Indicates whether date of birth is required for the individual search.","default":true}}},"id":"schema_456"},"schema_457":{"kind":"json-schema","data":{"type":"string","format":"date","example":"2015-07-04"},"id":"schema_457"},"schema_458":{"kind":"json-schema","data":{"type":"object","properties":{"correlationId":{"type":"string","format":"guid"},"totalSize":{"type":"integer","format":"int32"},"items":{"type":"array","items":{"$ref":"#/components/schemas/KYCProtectScheduleHitResponse"}}}},"id":"schema_458"},"schema_459":{"kind":"json-schema","data":{"type":"object","required":["threshold","name","datasets"],"properties":{"countryCodes":{"type":"array","description":"List of Two-letter country code ISO-3166-2.","items":{"type":"string"}},"threshold":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hits with scores below the chosen value will not be shown."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Must be one of 75, 80, 85, 90, 95, or 100"},"children":[]}]}]}],"format":"int32"},"sanctionBodies":{"type":["array","null"],"description":"Specifies which SanctionBodies will be searched. When null is supplied, the Settings preferences will be applied. When null is supplied and Settings preferences not set, all sanction bodies will be applied. When no sanction bodies supplied, all sanction bodies will be applied.","items":{"type":"integer"}},"name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name of the business to be searched."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Example - Google Inc"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Max 200 characters allowed."},"children":[]}]}]}]},"datasets":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies which datasets will be searched"},"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":"code","inline":true,"attributes":{"content":"PEP"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Politically Exposed Persons (All)"},"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":"PEP-LINKED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Only linked PEPs (PEP by Association)"},"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":"SAN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Sanctioned (All)"},"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":"SAN-CURRENT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Only current Sanctions"},"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":"SAN-FORMER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Only former Sanctions"},"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":"INS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Insolvency"},"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":"AM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Adverse Media"},"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":"POI"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Profile of Interest"},"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":"ENF"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Enforcement"},"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":"SOE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - State Owned Enterprises (All)"},"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":"SOE-CURRENT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Only current SOE"},"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":"SOE-FORMER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Only former SOE"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]}],"items":{"type":"string"}}}},"id":"schema_459"},"schema_460":{"kind":"json-schema","data":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","required":["searchId","riskRating"],"properties":{"assignedToUserId":{"type":["integer","null"],"description":"Id of the User to assign to the Search","format":"int32"},"status":{"type":["string","null"],"description":"Status of the Search. Available values are new, approved, declined, pending, cancelled, referred and closed."},"riskRating":{"type":["string","null"],"description":"Risk rating of the Search. Available values are notApplicable, veryLow, low, medium, high AND veryHigh."},"note":{"type":["string","null"],"description":"Note associated with the search"},"searchId":{"type":"string","description":"The Id of the search to be updated","format":"uuid"}}}}}},"id":"schema_460"},"schema_461":{"kind":"json-schema","data":{"type":"object","properties":{"assignedToUserId":{"type":"integer","description":"Id of the User to assign to the Search","format":"int32"},"status":{"type":"string","description":"Status of the Search. Available values are new, approved, declined, pending, cancelled, referred and closed."},"riskRating":{"type":"string","description":"Risk rating of the Search. Available values are notApplicable, veryLow, low, medium, high AND veryHigh."},"note":{"type":"string","description":"Note associated with the search"}}},"id":"schema_461"},"schema_462":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"}},"id":"schema_462"},"schema_463":{"kind":"json-schema","data":{"type":"object","properties":{"decision":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Decision of the Hit to be updated. The Decision can only be made once."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Allowed values are undecided,trueMatch and falsePositive"},"children":[]}]}]}]},"note":{"type":"string","description":"Note associated with the Hit"}}},"id":"schema_463"},"schema_464":{"kind":"json-schema","data":{"type":"object","properties":{"note":{"type":["null","string"]}}},"id":"schema_464"},"schema_465":{"kind":"json-schema","data":{"type":"object","properties":{"countryCodes":{"type":["array","null"],"items":{"type":"string"},"description":"List of Two-letter country code ISO-3166-2."},"threshold":{"type":"integer","description":"Must be one of 75, 80, 85, 90, 95, or 100","format":"int32"},"name":{"type":["string","null"],"description":"Required if FirstName and LastName are not provided example: Google Inc Max 200 characters allowed."},"datasets":{"type":["array","null"],"items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies which datasets will be searched "},"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":"PEP"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Politically Exposed Persons (All)  "},"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":"PEP-LINKED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Only linked PEPs (PEP by Association)  "},"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":"SAN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Sanctioned (All) SAN-CURRENT - Only current Sanctions SAN-FORMER - Only former Sanctions  "},"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":"INS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Insolvency  "},"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":"AM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Averse Media POI - Profile of Interest  "},"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":"ENF"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Enforcement  "},"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":"SOE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - State Owned Enterprises (All)  "},"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":"SOE-CURRENT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Only current  "},"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":"SOE SOE-FORMER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Only former SOE  "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]}]}}},"id":"schema_465"},"schema_466":{"kind":"json-schema","data":{"type":"object","properties":{"countryCodes":{"type":["array","null"],"items":{"type":"string"},"description":"List of Two-letter country code ISO-3166-2."},"threshold":{"type":"integer","description":"Must be one of 75, 80, 85, 90, 95, or 100","format":"int32"},"name":{"type":["string","null"],"description":"Required if FirstName and LastName are not provided example: Google Inc Max 200 characters allowed."},"firstName":{"description":"If FirstName is provided then LastName must also be provided","type":["string","null"]},"middleName":{"description":"Middle name is optional, valid along with Firstname and LastName only","type":["string","null"]},"lastName":{"description":"If LastName is provided then FirstName must also be provided","type":["string","null"]},"dateOfBirth":{"description":"Date YYYY-MM-DD or YYYY format. Must be after 1900 and not in the future.","format":"date","type":["string","null"]},"gender":{"type":["string","null"],"description":"Define the gender of the individual you are searching for."},"pepTiers":{"type":["array","null"],"items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When searching the PEP dataset, define what tiers of the PEP profiles should be included in the results."},"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":" PEP Tier 1 - Indicates senior Roles"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" PEP Tier 2 - Middle-Ranking"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" PEP Tier 3 - Junior Officials"},"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":" If the PEP Dataset is NOT included on the list of searched datasets, then this value is ignored. The PEP Tier filter does not apply to PEP-LINKED Profiles."},"children":[]}]}]}]},"datasets":{"type":["array","null"],"items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies which datasets will be searched"},"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":"code","inline":true,"attributes":{"content":"PEP"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Politically Exposed Persons (All) "},"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":"PEP-CURRENT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Only current PEPs "},"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":"PEP-FORMER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Only former PEPs "},"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":"PEP-LINKED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Only linked PEPs (PEP by Association)"},"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":"SAN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Sanctioned (All) "},"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":"SAN-CURRENT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Only current Sanctions "},"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":"SAN-FORMER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Only former Sanctions "},"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":"INS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Insolvency "},"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":"AM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Averse Media "},"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":"POI"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Profile of Interest "},"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":"ENF"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Enforcement "},"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":"DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Disqualified Director "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]}]}}},"id":"schema_466"},"schema_467":{"kind":"json-schema","data":{"type":"object","properties":{"totalSize":{"type":"integer","format":"int32"},"items":{"type":"array","items":{"$ref":"#/components/schemas/KYCProtectScheduleHitResponse"}}}},"id":"schema_467"},"schema_468":{"kind":"json-schema","data":{"type":"object","properties":{"totalSize":{"type":"integer","format":"int32"},"items":{"type":"array","items":{"$ref":"#/components/schemas/KycProtectGetSearchResponse"}}}},"id":"schema_468"},"schema_469":{"kind":"json-schema","data":{"type":"object","properties":{"searchIds":{"type":"array","items":{"type":"string","format":"uuid"},"description":"List of searches to link to a profile"}}},"id":"schema_469"},"schema_470":{"kind":"json-schema","data":{"type":"object","properties":{"successful":{"type":"array","items":{"type":["string","null"],"format":"uuid"}},"failed":{"type":["array","null"],"items":{"type":"object","properties":{"failedItem":{"type":"string","format":"uuid"},"error":{"$ref":"#/components/schemas/KycProtectProblemDetails"}}}}}},"id":"schema_470"},"schema_471":{"kind":"json-schema","data":{"type":"integer","format":"int32"},"id":"schema_471"},"schema_472":{"kind":"json-schema","data":{"type":"object","properties":{"totalSize":{"type":"integer","format":"int32"},"items":{"type":"array","items":{"$ref":"#/components/schemas/KYCProtectProfileAlertsMetricsResponse"}}}},"id":"schema_472"},"schema_473":{"kind":"json-schema","data":{"type":"string","enum":["profile","keyParty"]},"id":"schema_473"},"schema_474":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","enum":["profile","amlSearch","settings"]}},"id":"schema_474"},"schema_475":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","enum":["profileDetails","keyParty","amlMonitoring","preferences"]}},"id":"schema_475"},"schema_476":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","enum":["created","updated","deleted","searchRemoved","searchLinked","attachmentCreated","attachmentUpdated","attachmentDeleted","noteCreated","noteUpdated","noteDeleted","noteArchived","noteUnarchived","addressCreated","addressUpdated","addressDeleted","kycStatusUpdated","addedToAmlMonitoring","updatedInAmlMonitoring","removedFromAmlMonitoring"]}},"id":"schema_476"},"schema_477":{"kind":"json-schema","data":{"type":"array","items":{"type":"integer"}},"id":"schema_477"},"schema_478":{"kind":"json-schema","data":{"type":"string","format":"date"},"id":"schema_478"},"schema_479":{"kind":"json-schema","data":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/KycMonitoringKycAlertResponse"}},"totalSize":{"type":"integer","format":"int64"}}},"id":"schema_479"},"schema_480":{"kind":"json-schema","data":{"type":"object","required":["type","description"],"properties":{"type":{"type":["string","null"],"description":"The type of the address.","enum":["registered","trading","other"]},"buildingDetails":{"type":["string","null"],"description":"The building details of the address being created. Must have a maximum length of 250 characters."},"street":{"type":["string","null"],"description":"The street of the address being created. Must have a maximum length of 250 characters."},"city":{"type":["string","null"],"description":"The city of the address being created. Must have a maximum length of 250 characters."},"region":{"type":["string","null"],"description":"The region of the address being created. Must have a maximum length of 250 characters."},"postalCode":{"type":["string","null"],"description":"The postal code of the address being created. Must have a maximum length of 50 characters."},"countryCode":{"type":["string","null"],"description":"Two-letter ISO-3166-2 country code"},"description":{"type":["string","null"],"description":"The description of the address being created. Must have a maximum length of 250 characters"}}},"id":"schema_480"},"schema_481":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/KycProtectProfileGetDetailsAddressResponse"}},"id":"schema_481"},"schema_482":{"kind":"json-schema","data":{"type":"object","properties":{"failed":{"type":"array","items":{"$ref":"#/components/schemas/PostKYCKeypartiesByProfileIdFailedResponse"}},"successful":{"type":"array","items":{"$ref":"#/components/schemas/PostKYCKeypartiesByProfileIdResponse"}}}},"id":"schema_482"},"schema_483":{"kind":"json-schema","data":{"type":"object","properties":{"failed":{"type":"array","items":{"$ref":"#/components/schemas/PutKYCKeypartiesByProfileIdFailedResponse"}},"successful":{"type":"array","items":{"$ref":"#/components/schemas/PostKYCKeypartiesByProfileIdResponse"}}}},"id":"schema_483"},"schema_484":{"kind":"json-schema","data":{"type":"object","properties":{"keyPartyIds":{"type":"array","items":{"type":"string","format":"uuid"}}}},"id":"schema_484"},"schema_485":{"kind":"json-schema","data":{"type":"object","properties":{"items":{"type":["array","null"],"items":{"$ref":"#/components/schemas/AddKeyPartySearchContract"},"description":"The Request Items collection"}}},"id":"schema_485"},"schema_486":{"kind":"json-schema","data":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"keyPartyId":{"type":["string","null"],"description":"Id of the key party to link to the search"},"searchId":{"type":["string","null"],"description":"Id of the search to link to the key party"}}}}}},"id":"schema_486"},"schema_487":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/KycProtectProfileAssignBulkResponse"}},"id":"schema_487"},"schema_488":{"kind":"json-schema","data":{"type":"string","default":"full"},"id":"schema_488"},"schema_489":{"kind":"json-schema","data":{"type":"boolean","default":true},"id":"schema_489"},"schema_490":{"kind":"json-schema","data":{"type":"object","properties":{"correlationId":{"type":"string","format":"UUID"},"kycResponse":{"type":"object","properties":{"id":{"type":"string","format":"UUID","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A Unique Id that will be known as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Profile Id"},"children":[]}]}]}]},"profileUrl":{"type":"string"}}},"report":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsCompanyReportResponse"}}},"id":"schema_490"},"schema_491":{"kind":"json-schema","data":{"type":"object","properties":{"File":{"type":"string","description":"The attachment to be added. Size Limited to 50MB.","format":"binary"},"DocumentType":{"type":"string","description":"The document type of the attachment"},"Description":{"type":"string","description":"The description of the attachment. Limited to 250 characters."}}},"id":"schema_491"},"schema_492":{"kind":"json-schema","data":{"type":"object","properties":{"totalSize":{"type":"integer","format":"int32"},"items":{"type":"array","items":{"$ref":"#/components/schemas/KycProtectProfileGetAttachmentResponse"}}}},"id":"schema_492"},"schema_493":{"kind":"json-schema","data":{"type":"string","enum":["amlAlert","audit","profile","amlScreen","monitorSearch"]},"id":"schema_493"},"schema_494":{"kind":"json-schema","data":{"type":"object","properties":{"downloadUrl":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The direct URL to download the report file. This URL is valid only until the expiration time  specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expiresAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},"fileName":{"type":"string","description":"The name of the report file as specified during creation.\n"},"expiresAt":{"type":"string","format":"date-time","description":"The date and time when the download URL will expire. After this time, the URL will no longer  be valid, and the report must be regenerated if needed.\n"}}},"id":"schema_494"},"schema_495":{"kind":"json-schema","data":{"type":"object","properties":{"additionalProperties":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional fields applicable to the specific report type. These may vary depending on whether the report  type is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amlAlert"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"audit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Nested arrays and objects are supported for complex criteria."},"children":[]}]}]}],"type":"object"},"correlationId":{"type":"string","description":"Unique identifier for tracking the request, useful for debugging and tracing."}}},"id":"schema_495"},"schema_496":{"kind":"json-schema","data":{"type":"array","items":{"type":"integer","format":"int32"}},"id":"schema_496"},"schema_497":{"kind":"json-schema","data":{"type":"array","items":{"enum":["pepTier1","pepTier2","pepTier3","byAssociation"],"type":"string"}},"id":"schema_497"},"schema_498":{"kind":"json-schema","data":{"enum":["Both","Validate","Verify"]},"id":"schema_498"},"schema_499":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/GBLocalSolutionGetHistoryListResponse"}},"id":"schema_499"},"schema_500":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/SortCodeCheckResponse"}},"id":"schema_500"},"schema_501":{"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_501"},"schema_502":{"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_502"},"schema_503":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/ConnectFootprintDataFinance"},{"$ref":"#/components/schemas/ConnectFootprintIndicatorData"},{"$ref":"#/components/schemas/ConnectIndicatorData"},{"$ref":"#/components/schemas/ConnectFullFinanceData"}]},"id":"schema_503"},"schema_504":{"kind":"json-schema","data":{"type":"string","enum":["searchSupport"]},"id":"schema_504"},"schema_505":{"kind":"json-schema","data":{"type":"string","pattern":"/^(GB|IE)-[01]-.+$/i"},"id":"schema_505"},"schema_506":{"kind":"json-schema","data":{"type":"string","enum":["AM","AV","BS","CA","DC","DS","EC","GI","QS","TV","GC"]},"id":"schema_506"},"schema_507":{"kind":"json-schema","data":{"type":"string","pattern":"/^(GB|IE)-.+$/i"},"id":"schema_507"},"schema_508":{"kind":"json-schema","data":{"type":["string","null"],"enum":["alert.accepted","alert.rejected","alert.received","investigation.accepted","investigation.created","investigation.rejected","investigation.removed","investigation.file_downloaded","investigation.risk_assigned","investigation.record_removed","investigation.note_removed","investigation.assigned_to","investigation.status","idv.file_downloaded","idv.gdc_search","note.created","profile.created","profile.added","profile.updated","schedule.created","schedule.recharged","schedule.disabled","schedule.deleted","schedule.removed","schedule.updated","report.monitoring.requested","report.monitoring.submitted","report.monitoring.completed","report.monitoring.failed"]},"id":"schema_508"},"schema_509":{"kind":"json-schema","data":{"type":["string","null"],"format":"uuid"},"id":"schema_509"},"schema_510":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/ConnectProtectAuditDto"}},"id":"schema_510"},"schema_511":{"kind":"json-schema","data":{"type":["string","null"],"default":"EN","maxLength":2,"minLength":2},"id":"schema_511"},"schema_512":{"kind":"json-schema","data":{"type":"object","properties":{"correlationId":{"type":"string","description":"Unique identifier for tracing the request."},"totalSize":{"type":"integer","format":"int32"},"consumers":{"type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsConsumerConsumerReport"}}}},"id":"schema_512"},"schema_513":{"kind":"json-schema","data":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsConsumerCriteriaSet"}]}},"id":"schema_513"},"schema_514":{"kind":"json-schema","data":{"type":"object","example":{"customData":[{"key":"de_reason_code","optional":false,"allowedValues":["1","2","3","4","5","6","7","8"],"description":["DE report retrieval reason code:","1 - Credit Decision'","2 - Credit Assessment - Future business connection (with credit risk)","3 - Credit Assessment - Existing business connection (with credit risk)","4 - Realisation check receivables collection","5 - Purchase Contract - Intention of signature of purchase contract (with credit risk)","6 - Goods Credit Insurance (with credit risk)","7 - Contract - Intention of signature of leasing or rent contract (with credit risk)","8 - Insurance Contract - Intention of signature of a insurance contract (with credit risk)"]}],"country":"DE"}},"id":"schema_514"},"schema_515":{"kind":"json-schema","data":{"type":"string","pattern":"^[A-Z]{2}$","maxLength":2,"minLength":2},"id":"schema_515"},"schema_516":{"kind":"json-schema","data":{"type":"string","enum":["basic","hardcheck"],"default":"basic"},"id":"schema_516"},"schema_517":{"kind":"json-schema","data":{"type":"string","pattern":"^[a-zA-Z0-9]+$"},"id":"schema_517"},"schema_518":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/CreditsafeGlobalDataReportsConsumerCriteriaSet"}},"id":"schema_518"}},"exampleStore":{"paths/~1compliance~1countryRisk~1{countryCode}/get/responses/200/content/application~1json/examples/standardResponse":{"value":{"correlationId":"f563b6bc-549f-4d4a-95bc-c658b407bd2f","country":{"countryCodeIso3":"MAF","countryCodeIso2":"MF","countryName":"Saint Martin (French part)","region":"Americas"},"risk":{"oecdMember":false,"worldBankClassification":"High income","countryRiskIndicatorAml":{"countryRank":154,"countryUniverse":249,"dataQualityCategorical":"Poor","dataQualityNumeric":2,"euHighRiskFlag":false,"fatfHighRisk":false,"fatfIncreasedMonitoring":false,"riskClassificationCategorical":"High","riskClassificationNumeric":4,"score":42.86},"countryRiskIndicatorEsg":{"dataQualityCategorical":"Very Poor","countryUniverse":186,"dataQualityNumeric":1,"riskClassificationCategorical":null,"score":null,"countryRank":null,"riskClassificationNumeric":null},"countryRiskIndicatorSovereign":{"dataQualityCategorical":"Very Poor","dataQualityNumeric":1,"countryUniverse":184,"riskClassificationCategorical":null,"score":null,"countryRank":null,"riskClassificationNumeric":null},"countryRiskIndicatorSupplyChainRisk":{"dataQualityCategorical":"Very Poor","riskClassificationCategorical":"Very Low","score":12.63,"countryRank":18,"countryUniverse":233,"dataQualityNumeric":1,"riskClassificationNumeric":1}}},"key":"standardResponse","summary":"Typical single-country response","id":"paths/~1compliance~1countryRisk~1{countryCode}/get/responses/200/content/application~1json/examples/standardResponse"},"paths/~1freshinvestigations~1{orderId}~1comments/post/requestBody/content/application~1json/example":{"value":{"comments":"comments by user"},"id":"paths/~1freshinvestigations~1{orderId}~1comments/post/requestBody/content/application~1json/example"},"paths/~1dataCleaning~1jobs/post/requestBody/content/application:json/example":{"value":{"name":"Create a Data Cleaning Job 03-10-20xx"},"id":"paths/~1dataCleaning~1jobs/post/requestBody/content/application:json/example"},"paths/~1dataCleaning~1jobs~1{id}~1enrichedFile/get/responses/200/content/application~1json/example":{"value":{"correlationId":"string","filePath":"string"},"id":"paths/~1dataCleaning~1jobs~1{id}~1enrichedFile/get/responses/200/content/application~1json/example"},"paths/~1dataCleaning~1jobs~1{id}~1enrichments/put/responses/200/content/application~1json/example":{"value":{"enrichments":[{"enrichment":"Tag Name from request body"}]},"id":"paths/~1dataCleaning~1jobs~1{id}~1enrichments/put/responses/200/content/application~1json/example"},"paths/~1dataCleaning~1jobs~1{id}~1submit/post/responses/200/content/application~1json/example":{"value":{"messageId":"string"},"id":"paths/~1dataCleaning~1jobs~1{id}~1submit/post/responses/200/content/application~1json/example"},"paths/~1monitoring~1portfolios~1{portfolioId}~1import/post/requestBody/content/multipart~1form-data/example":{"value":{"importCsv":"FILE_PATH","email":"john.smith@creditsafe.com"},"id":"paths/~1monitoring~1portfolios~1{portfolioId}~1import/post/requestBody/content/multipart~1form-data/example"},"paths/~1monitoring~1portfolios~1{portfolioId}~1sync/post/requestBody/content/multipart~1form-data/example":{"value":{"importCsv":"FILE_PATH","email":"john.smith@creditsafe.com"},"id":"paths/~1monitoring~1portfolios~1{portfolioId}~1sync/post/requestBody/content/multipart~1form-data/example"},"paths/~1monitoring~1portfolios~1{portfolioId}/patch/requestBody/content/application~1json/example":{"value":{"name":"New portfolio Name","emails":[{"firstName":"John","lastName":"Smith","emailAddress":"john.smith@creditsafe.com"}],"frequency":"1"},"id":"paths/~1monitoring~1portfolios~1{portfolioId}/patch/requestBody/content/application~1json/example"},"paths/~1monitoring~1portfolios~1{portfolioId}~1companies~1copy/post/requestBody/content/application~1json/example":{"value":{"portfolios":[196854,197369],"companies":[{"id":"BE-X-733313367"},{"id":"BE-X-868222848"},{"id":"BE-X-835695382"}]},"id":"paths/~1monitoring~1portfolios~1{portfolioId}~1companies~1copy/post/requestBody/content/application~1json/example"},"paths/~1monitoring~1portfolios~1{portfolioId}~1companies~1remove/post/requestBody/content/application~1json/example":{"value":{"portfolios":[196854,197369],"companies":[{"id":"BE-X-733313367"},{"id":"BE-X-868222848"},{"id":"BE-X-835695382"}]},"id":"paths/~1monitoring~1portfolios~1{portfolioId}~1companies~1remove/post/requestBody/content/application~1json/example"},"paths/~1monitoring~1portfolios~1{portfolioId}~1sharingPermissions/patch/requestBody/content/application~1json/example":{"value":{"revokeAll":"false","userPermissions":[{"csUserId":101106166,"permissions":"View,Add"},{"csUserId":1000027380,"permissions":"View,Add,Edit,Remove"}]},"id":"paths/~1monitoring~1portfolios~1{portfolioId}~1sharingPermissions/patch/requestBody/content/application~1json/example"},"paths/~1monitoring~1portfolios~1{portfolioId}~1companies/post/requestBody/content/application~1json/examples/id only":{"value":{"id":"GB-0-12345678","personalReference":"","freeText":"","personalLimit":""},"key":"id only","summary":"Submitting a requestBody with only an 'id'","id":"paths/~1monitoring~1portfolios~1{portfolioId}~1companies/post/requestBody/content/application~1json/examples/id only"},"paths/~1monitoring~1portfolios~1{portfolioId}~1companies/post/requestBody/content/application~1json/examples/All Fields":{"value":{"id":"GB-0-12345678","personalReference":"Some Text","freeText":"Some Useful Text","personalLimit":"40"},"key":"All Fields","summary":"Submitting a requestBody with all fields","id":"paths/~1monitoring~1portfolios~1{portfolioId}~1companies/post/requestBody/content/application~1json/examples/All Fields"},"paths/~1monitoring~1portfolios~1{portfolioId}~1companies~1{companyId}/patch/requestBody/content/application~1json/example":{"value":{"personalReference":"personal reference","freeText":"Some useful text","personalLimit":"40"},"id":"paths/~1monitoring~1portfolios~1{portfolioId}~1companies~1{companyId}/patch/requestBody/content/application~1json/example"},"paths/~1monitoring~1portfolios~1{portfolioId}~1companies~1clear/patch/requestBody/content/application~1json/example":{"value":{"companies":["BE-X-733313367","BE-X-868222848"]},"id":"paths/~1monitoring~1portfolios~1{portfolioId}~1companies~1clear/patch/requestBody/content/application~1json/example"},"paths/~1monitoring~1portfolios~1{portfolioId}~1eventRules~1{countryCode}/put/requestBody/content/application~1json/example":{"value":[{"ruleCode":101,"isActive":1,"param0":1,"param1":"A","param2":true},{"ruleCode":1802,"isActive":1,"param0":"10"},{"ruleCode":1815,"isActive":0}],"id":"paths/~1monitoring~1portfolios~1{portfolioId}~1eventRules~1{countryCode}/put/requestBody/content/application~1json/example"},"paths/~1compliance~1kyc-protect~1reports~1criteria~1{type}/get/responses/200/content/application~1json/example":{"value":{"fromDate":{"isRequired":true,"type":"string","format":"yyyy-mm-dd","description":"Cannot be a future date","acceptableValues":null},"toDate":{"isRequired":true,"type":"string","format":"yyyy-mm-dd","description":"Should fall after fromDate, results will be fetched excluding the provided to date","acceptableValues":null},"hitDecisions":{"isRequired":false,"type":"array[string]","format":null,"description":"Decisions made on hits. Multiple values are acceptable","acceptableValues":["Undecided","TrueMatch","FalsePositive","Discarded"]},"hasHits":{"isRequired":false,"type":"boolean","format":null,"description":"Indicates if there are any hits.","acceptableValues":["true","false"]}},"id":"paths/~1compliance~1kyc-protect~1reports~1criteria~1{type}/get/responses/200/content/application~1json/example"}},"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/connect-api-full/connectapi","position":"off","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/connect-apis-catalog/product-catalog/Connect-API-Full/connectAPI.json?download"},{"url":"/_bundle/connect-apis-catalog/product-catalog/Connect-API-Full/connectAPI.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Creditsafe Connect","description":"\n\n# Introduction \n\nThis is the full Connect API and contains all available endpoints. For additional information, integration processes, and supplementary documentation, please use the targeted product\n\nThe Creditsafe Connect API is a REST API that provides access to the <a href=\"https://www.creditsafe.com/gb/en/more/about/our-data.html\" target=\"_blank\" rel=\"noopener noreferrer\">Creditsafe Global Company Database (opens in new tab).</a> This allows you to: <ul><li>Control your master data</li><li>Utilize up-to-date Business and Director information, enhancing your onboarding and qualification processes</li><li>Receive alerts when your customer's and supplier's Credit Report changes</li></ul><br>\n\n## Quick Start\n\nTo start your Creditsafe Connect API integration you will need to have activated your account and set a password by following the instructions in your Welcome Email. If you have not received a Welcome Email please contact your Creditsafe Account Manager.</br></br>By default, you will have been setup on our Sandbox environment.</br></br>\n\nUsing a REST API client construct an `/authenticate` POST request and enter your username & password (case-sensitive) into the POST body. A successful response will return an  `authentication token`.</br></br>\n\nUse the `authentication token` in an `Authorization` header on all other Creditsafe Connect calls as proof of your authenticity.\n","status":"published","tags":["Retained"]}},"baseSlug":"/connect-apis-catalog/product-catalog/connect-api-full/connectapi","routesMapping":{}}