{"items":[{"type":"link","fsPath":"connect-apis-catalog/product-catalog/Connect-API-Full/index.md","metadata":{"type":"markdown"},"label":"Introduction","link":"/connect-apis-catalog/product-catalog/connect-api-full","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full"},{"type":"link","fsPath":"connect-apis-catalog/product-catalog/Connect-API-Full/gettingStarted.md","metadata":{"type":"markdown"},"label":"Getting Started","link":"/connect-apis-catalog/product-catalog/connect-api-full/gettingstarted","routeSlug":"/connect-apis-catalog/product-catalog/connect-api-full/gettingstarted"},{"type":"group","label":"API Documentation","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"},{"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"}]},{"type":"separator","label":"Access"},{"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."}},"httpPath":"/authenticate"}]},{"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."}},"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"}},"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."}},"httpPath":"/access/users/me"}]},{"type":"separator","label":"Check and Decide"},{"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."}},"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."}},"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."}},"httpPath":"/decisionEngine/instances"}]},{"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."}},"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."}},"httpPath":"/decisionEngine/GUID"}]},{"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."}},"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."}},"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."}},"httpPath":"/decisionEngine/usageLog/{decisionLogId}"}]},{"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."}},"httpPath":"/decisionEngine/{provenirId}"}]},{"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."}},"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"}},"httpPath":"/decisionEngine/decisionOutcome/{guid}"}]},{"type":"separator","label":"Country Risk Compliance"},{"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."}},"httpPath":"/compliance/countryRisk/{countryCode}"}]},{"type":"separator","label":"Bank Match"},{"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"}},"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"}},"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"}},"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"}},"httpPath":"/compliance/bankMatch/IBAN/company/searchCriteria"}]},{"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"}},"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"}},"httpPath":"/compliance/bankMatch/IBAN/person/searchCriteria"}]},{"type":"separator","label":"Credit and Risk"},{"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."}},"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."}},"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."}},"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."}},"httpPath":"/people/searchcriteria"}]},{"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."}},"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."}},"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."}},"httpPath":"/companies/match"}]},{"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."}},"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."}},"httpPath":"/people/{peopleId}"}]},{"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"httpPath":"/localSolutions/GB/identitysearch/searchreasons"}]},{"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."}},"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."}},"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."}},"httpPath":"/images/companies/types"}]},{"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"httpPath":"/freshinvestigations/{orderId}/report"}]},{"type":"separator","label":"Data cleaning"},{"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."}},"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."}},"httpPath":"/dataCleaning/jobs"}]},{"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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'."}},"httpPath":"/dataCleaning/jobs/{id}/upload"}]},{"type":"separator","label":"Global monitoring"},{"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."}},"httpPath":"/monitoring/user/details"}]},{"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."}},"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."}},"httpPath":"/monitoring/portfolios"}]},{"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"}},"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"}},"httpPath":"/monitoring/portfolios/{portfolioId}/sync"}]},{"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"httpPath":"/monitoring/portfolios/{portfolioId}/sharingPermissions"}]},{"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"httpPath":"/monitoring/portfolios/{portfolioId}/riskSummary"}]},{"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."}},"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."}},"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."}},"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."}},"httpPath":"/monitoring/notificationEvents"}]},{"type":"separator","label":"KYC Compliance (Know Your Customer)"},{"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."}},"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."}},"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."}},"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."}},"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"}},"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."}},"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."}},"httpPath":"/compliance/kyc-protect/settings/preferences/aml"}]},{"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"}},"httpPath":"/compliance/kyc-protect/profiles/{profileId}/searches/bulk"}]},{"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"httpPath":"/compliance/kyc-protect/schedules/amlAlerts"}]},{"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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"}},"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"}},"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."}},"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"}},"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"}},"httpPath":"/compliance/kyc-protect/searchLinks/businesses/{supplierHitId}/download"}]},{"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."}},"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."}},"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."}},"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."}},"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."}},"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"}},"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."}},"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."}},"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."}},"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."}},"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."}},"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"}},"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"}},"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."}},"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"}},"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"}},"httpPath":"/compliance/kyc-protect/searchLinks/individuals/{supplierHitId}/download"}]},{"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"httpPath":"/compliance/kyc-protect/profiles/alerts/metrics"}]},{"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."}},"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."}},"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."}},"httpPath":"/compliance/kyc-protect/asyncAmlJobs/{jobId}/criteria"}]},{"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."}},"httpPath":"/compliance/kyc-protect/audits"}]},{"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."}},"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."}},"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."}},"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.."}},"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."}},"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
Returns the template to complete a batch upload."}},"httpPath":"/compliance/kyc-protect/batchUploads/template"}]},{"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."}},"httpPath":"/compliance/kyc-protect/complianceAlerts/{connectId}"}]},{"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"}},"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."}},"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."}},"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"}},"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."}},"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."}},"httpPath":"/compliance/kyc-protect/lookup/kycMonitoring/countryCodes"}]},{"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."}},"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."}},"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."}},"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."}},"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."}},"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"}},"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."}},"httpPath":"/compliance/kyc-protect/profiles/{profileId}/details/addresses/{addressId}"}]},{"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."}},"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."}},"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"}},"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."}},"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."}},"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."}},"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."}},"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"}},"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"}},"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."}},"httpPath":"/compliance/kyc-protect/profiles/{profileId}/keyparties/searches/link"}]},{"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."}},"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."}},"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."}},"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."}},"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."}},"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"}},"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."}},"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."}},"httpPath":"/compliance/kyc-protect/profiles/businesses/import"}]},{"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."}},"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."}},"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."}},"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."}},"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"}},"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"}},"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"httpPath":"/compliance/kyc-protect/profiles/{profileId}/notes/{noteId}"}]},{"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."}},"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."}},"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."}},"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."}},"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."}},"httpPath":"/compliance/kyc-protect/reports/criteria/{type}"}]},{"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."}},"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."}},"httpPath":"/compliance/kyc-protect/searches/monitored/download"}]},{"type":"separator","label":"Local Solutions"},{"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."}},"httpPath":"/localSolutions/GB/bankmatch"}]},{"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"httpPath":"/localSolutions/GB/bankVerification/validate/{id}"}]},{"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."}},"httpPath":"/localSolutions/GB/landRegistry/{companyId}"}]},{"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."}},"httpPath":"/localSolutions/GB/CCDS/{companyId}"}]},{"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."}},"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’."}},"httpPath":"/localSolutions/FR/bankmatch/audition"}]},{"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."}},"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."}},"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."}},"httpPath":"/localSolutions/DE/nonLtdCompanies/searchcriteria"}]},{"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"}},"httpPath":"/localSolutions/NL/extract/{kvkNumber}"}]},{"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."}},"httpPath":"/localSolutions/US/searchSupport"}]},{"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."}},"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."}},"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."}},"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."}},"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."}},"httpPath":"/localSolutions/GB/verify/individual/directReport"}]},{"type":"separator","label":"Protect (Legacy)"},{"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."}},"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."}},"httpPath":"/protect/audits"}]},{"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."}},"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."}},"httpPath":"/protect/idv/gdc/search"}]},{"type":"separator","label":"Consumers and Misc"},{"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."}},"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."}},"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."}},"httpPath":"/reportcustomdata/{country}"}]},{"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."}},"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."}},"httpPath":"/consumers/tryReport/searchcriteria"}]}]}]}