# Creditsafe Connect # Introduction This is the full Connect API and contains all available endpoints. For additional information, integration processes, and supplementary documentation, please use the targeted product The Creditsafe Connect API is a REST API that provides access to the Creditsafe Global Company Database. This allows you to:
## Quick Start To start your Creditsafe Connect API integration you will need to have activated your account and set a password by following the instructions in your Welcome Email. If you have not received a Welcome Email please contact your Creditsafe Account Manager.

By default, you will have been setup on our Sandbox environment.

Using a REST API client construct an `/authenticate` POST request and enter your username & password (case-sensitive) into the POST body. A successful response will return an `authentication token`.

Use the `authentication token` in an `Authorization` header on all other Creditsafe Connect calls as proof of your authenticity. Version: 1.10.9 Metadata: - tags: ["Retained"] ## Servers Sandbox server ``` https://connect.sandbox.creditsafe.com/v1 ``` Production server ``` https://connect.creditsafe.com/v1 ``` ## Security ### bearerToken This API requires authentication for access to protected endpoints. Authentication is performed by providing a valid JWT token in the `Authorization` header of each request. Type: http Scheme: bearer Bearer Format: JWT ## Download OpenAPI description [Creditsafe Connect](https://doc.creditsafe.com/_spec/connect-apis-catalog/product-catalog/Connect-API-Full/connectAPI.yaml) ## Authentication Endpoints for user authentication into the Connect API. ### Authenticate - [POST /authenticate](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/authentication/authenticate.md): Supply username and password to generate Authentication Token. ## User Administration Endpoints for user management. ### Subscription Details - [GET /access](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/user-administration/subscriptiondetails.md): Returns the available countries in your subscription - Company Report, Director Report, Offline Reports and Monitoring. ### List of Active Users - [GET /access/users/active](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/user-administration/protectgetactivecustomerusers.md): Returns a collection of user details with in the customer ### Logged In User Details - [GET /access/users/me](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/user-administration/protectgetdetailsofloggedinuser.md): Returns the details of logged in user. ## Search And Report Schemas/Criteria ### Return Languages Available For Company Reports For Selected Country - [GET /access/countries/{countryCode}/reportLanguages](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/search-and-report-schemascriteria/useraccessreportlanguages.md): 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. > Note: The availability of field content in a specific language depends on the data source. If certain properties in the report are not available in the chosen language, they will default to English. As a result, only a certain percentage of the report may appear in the selected language. ### Company Search Criteria - [GET /companies/searchcriteria](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/search-and-report-schemascriteria/companysearchcriteria.md): Returns the set of available Company Search parameters/fields for a provided list of countries. ### People/Director Search Criteria - [GET /people/searchcriteria](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/search-and-report-schemascriteria/people/directorsearchcriteria.md): Returns the set of available People Search parameters/fields for a provided list of countries. ### Report Schema Structure Per Country - [GET /companies/schema/{countryCode}](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/search-and-report-schemascriteria/reportschema.md): 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. ## Companies Endpoints to search for Companies in the Creditsafe Global Company Database. Companies are uniquely identified by the `connectId` - the identifier used to order a Company Credit Report. The Company Credit Report is a JSON object comprising of key business and financial data points such as Credit Score & Limit, Industry Code, Directors, Balance Sheet and Negative Information. A full list of Company data points can be found in the Data Matrix, in the help resources. ### Company Search - [GET /companies](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/companies/companysearch.md): 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 where available. If a unique identifier is not available, use a combination of the companies registered and for the next best hit rate. ### Company Credit Report - [GET /companies/{connectId}](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/companies/companycreditreport.md): 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. ### Confidence Match Search - [GET /companies/match](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/companies/confidencematchsearch.md): Supply all company search criteria to find potential company matches ranked by a . - See here for more information. ## People/Directors Endpoints to find People/Directors and order Director Reports. A Director Report will contain a person's registered information and Active & Previous Directorships, where available. This endpoint is not advised to get a list of directors for a specific Company. Instead, order a Company Credit Report using the `/companies/{id}` endpoint, and use the `directors` section in the response.

### Director Search - [GET /people](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/peopledirectors/directorssearch.md): Endpoint to find Directors based on search criteria to order a Creditsafe Director Report. ### Director Report - [GET /people/{peopleId}](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/peopledirectors/directorreport.md): Returns a report from the ID supplied to the search. ## GB Consumers and AML ### Submit A GB Consumer or AML Search - [POST /localSolutions/GB/identitysearch](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/gb-consumers-and-aml/submitsagbconsumeroramlsearch.md): 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. ### Resolve A Picklist Against A Given UniqueId - [PUT /localSolutions/GB/identitysearch](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/gb-consumers-and-aml/resolvesapicklistagainstagivenuniqueid.md): 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. ### Return List Of Identity Search History Items - [GET /localSolutions/GB/identitysearch/history](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/gb-consumers-and-aml/getidentitysearchhistory.md): Retrieves a paginated history list for the specified customer/user, filtered based on the include* parameters. ### Return Previous Identity Search Result - [GET /localSolutions/GB/identitysearch/history/{uniqueId}](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/gb-consumers-and-aml/retrievesaprioridentitysearchresult.md): 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. ### Return Previous Identity Search Input - [GET /localSolutions/GB/identitysearch/history/{uniqueId}/input](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/gb-consumers-and-aml/retrievesaprioridentitysearchesinput.md): This will return the input criteria used in a search for a specified id. ### Set Reference For An Existing History Item - [PUT /localSolutions/GB/identitysearch/history/{uniqueId}/reference](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/gb-consumers-and-aml/setsthereferenceforanexistinghistoryitem.md): 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. ### Revalidate A Given Identity Search With Additional Documents - [PUT /localSolutions/GB/identitysearch/revalidation/{uniqueId}](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/gb-consumers-and-aml/revalidateagivenidentitysearchwithadditionaldocuments.md): Revalidate's a given identity search with additional documents. ### Return Identity Search Reasons - [GET /localSolutions/GB/identitysearch/searchreasons](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/gb-consumers-and-aml/paths/~1localsolutions~1gb~1identitysearch~1searchreasons/get.md): 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. ## Images Endpoints to order official Company Image/Filing Documents from source. Company Filings such as Annual Account Statements, Annual Returns, Liquidations and Changes of Registered Information can be downloaded as PDFs, and are typically used as a resource in extended company auditing/compliance.
### Company Image Documents - [GET /images/companies](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/images/companyimagedocuments.md): Returns the available Images for a given Company connectId. ### Image Document Category Types - [GET /images/companies/types](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/images/imagedocumentcategorytypes.md): Lists available Image Document formats, types and languages per country. ### Company Image - [GET /images/{imageId}](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/images/companyimage.md): Endpoint to order an Image Document by Image ID. ## Fresh Investigations Endpoints to manage Fresh Investigation requests. With the need for accurate data, you can check on any company that is not available within our instant online database by placing a Fresh Investigation (Offline Order). Depending on the market, the information we obtain will vary. Using official sources and registries we are able to quickly answer questions about a company's stability and financial health. Where official information is not available we will conduct a direct interview with the business. ### Create Fresh Investigation - [POST /freshinvestigations](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/fresh-investigations/createfreshinvestigation.md): 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 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. ### Get Fresh Investigations - [GET /freshinvestigations](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/fresh-investigations/getfreshinvestigations.md): Returns a list of your submitted Fresh Investigation Orders. ### Retrieve FreshInvestigation Order - [GET /freshinvestigations/{orderId}](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/fresh-investigations/retrievefreshinvestigationorder.md): Returns a specific Fresh Investigation order. ### Delete Fresh Investigations - [DELETE /freshinvestigations/{orderId}](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/fresh-investigations/deletefreshinvestigations.md): Deletes specified investigations. ### Update FreshInvestigation Report Content - [PATCH /freshinvestigations/{orderId}](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/fresh-investigations/updatefreshinvestigationreportcontent.md): Update the Fresh Investigation Report data for a specific order, after the order has a status of delivered. ### Upload attachments for fresh investigation orderId - [POST /freshinvestigations/{orderId}/attachments](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/fresh-investigations/uploadattachmentsforfreshinvestigationorderid.md): Returns the status of attachment upload for the particular order. ### Get attachments for the given fresh investigation orderId - [GET /freshinvestigations/{orderId}/attachments](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/fresh-investigations/getattachmentsforthegivenfreshinvestigationorderid.md): Returns attachments available for that particular order. ### Get attachment for the given fresh investigation attachment Id - [GET /freshinvestigations/{orderId}/attachments/{id}](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/fresh-investigations/getattachmentforthegivenfreshinvestigationattachmentid.md): Retrieve attachment for the given attachmentId. ### Comments for fresh investigation orderId - [POST /freshinvestigations/{orderId}/comments](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/fresh-investigations/commentsforfreshinvestigationorderid.md): Returns the status of comments for the particular order. ### Retrieve comments of specified FreshInvestigation Report - [GET /freshinvestigations/{orderId}/comments](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/fresh-investigations/retrievecommentsofspecifiedfreshinvestigationreport.md): Returns the Fresh Investigation Report comments for a specific order. ### Retrieve FreshInvestigation Report Content - [GET /freshinvestigations/{orderId}/report](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/fresh-investigations/retrievefreshinvestigationreportcontent.md): Returns the Fresh Investigation Report data for a specific order, after the order has a status of delivered. ## User Details ### Monitoring User Details - [GET /monitoring/user/details](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/user-details/monitoringuserdetails.md): You would use this endpoint to retrieve the user details related to the Global Monitoring product, such as the user's information. ## Create and View All Portfolios ### List All Portfolios - [GET /monitoring/portfolios](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/create-and-view-all-portfolios/listallportfolios.md): This endpoint allows you to manage portfolios. You can use the GET method to retrieve all portfolios associated with the user. ### Create Monitoring Portfolio - [POST /monitoring/portfolios](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/create-and-view-all-portfolios/createmonitoringportfolio.md): 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. ## Importing Portfolios ### Import A Portfolio File - [POST /monitoring/portfolios/{portfolioId}/import](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/importing-portfolios/importaportfoliofile.md): 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.. ### Sync A Portfolio File - [POST /monitoring/portfolios/{portfolioId}/sync](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/importing-portfolios/syncaportfoliofile.md): 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. ## User Management of Portfolios ### Retrieve Portfolio By Id - [GET /monitoring/portfolios/{portfolioId}](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/user-management-of-portfolios/retrieveportfoliobyid.md): This endpoint allows you to retrieve the portfolio details from the portfolioId. ### Delete Portfolio - [DELETE /monitoring/portfolios/{portfolioId}](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/user-management-of-portfolios/deleteportfolio.md): This endpoint allows you to delete the portfolio using the portfolioId. ### Update Portfolio Details - [PATCH /monitoring/portfolios/{portfolioId}](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/user-management-of-portfolios/updateportfoliodetails.md): This endpoint allows you to update Portfolio details such as Name, email recipients, language and subject line. ### Copy Companies Between Portfolios - [POST /monitoring/portfolios/{portfolioId}/companies/copy](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/user-management-of-portfolios/copycompaniesbetweenportfolios.md): 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. ### Move Companies Between Portfolios - [POST /monitoring/portfolios/{portfolioId}/companies/remove](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/user-management-of-portfolios/movecompaniesbetweenportfolios.md): 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. ### Portfolio User Permissions - [GET /monitoring/portfolios/{portfolioId}/sharingPermissions](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/user-management-of-portfolios/portfoliouserpermissions.md): Retrieve user permissions within the customer for a portfolio. ### Share Portfolio With Users - [PATCH /monitoring/portfolios/{portfolioId}/sharingPermissions](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/user-management-of-portfolios/shareportfoliowithusers.md): Update/Create user permissions within the customer for portfolio. ## Individual Portfolio Management ### List Countries of Monitored Companies - [GET /monitoring/portfolios/{portfolioId}/countries](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/individual-portfolio-management/listcountriesofmonitoredcompanies.md): This endpoint provides a list of distinct countries associated with the companies monitored within a specific portfolio. ### List Companies In A Portfolio - [GET /monitoring/portfolios/{portfolioId}/companies](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/individual-portfolio-management/listcompaniesinaportfolio.md): This endpoints gets all companies from a specific portfolio based on the portfolio id, optionally filter with query parameters. ### Add Company To Portfolio - [POST /monitoring/portfolios/{portfolioId}/companies](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/individual-portfolio-management/addcompanytoportfolio.md): 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. ### Clear Companies From Portfolio - [PATCH /monitoring/portfolios/{portfolioId}/companies/clear](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/individual-portfolio-management/clearcompaniesfromportfolio.md): This endpoint allows for companies to be deleted from the specified portfolio. ### Get Company Details From A Portfolio - [GET /monitoring/portfolios/{portfolioId}/companies/{companyId}](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/individual-portfolio-management/getcompanydetailsfromaportfolio.md): This endpoint allows you to get various company details from a portfolio. Requires a portfolioID and companyID in the PATH of the request. ### Delete Company From Portfolio - [DELETE /monitoring/portfolios/{portfolioId}/companies/{companyId}](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/individual-portfolio-management/deletecompanyfromportfolio.md): Endpoint to delete a company from a portfolio. ### Update Company Details In Portfolio - [PATCH /monitoring/portfolios/{portfolioId}/companies/{companyId}](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/individual-portfolio-management/updatecompanydetailsinportfolio.md): Updates the company details in a specified portfolio. ### List Portfolio Event Rules - [GET /monitoring/portfolios/{portfolioId}/eventRules](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/individual-portfolio-management/listportfolioeventrules.md): Get all notification for the given . Notification event rules allow you to control which events you wish to monitor for the contained within the given . ### List Portfolio Event Rules By Country - [GET /monitoring/portfolios/{portfolioId}/eventRules/{countryCode}](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/individual-portfolio-management/listportfolioeventrulesbycountry.md): Endpoint to 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. ### Update EventRules - [PUT /monitoring/portfolios/{portfolioId}/eventRules/{countryCode}](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/individual-portfolio-management/updateeventrules.md): 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 number of the eventRule you want to update, with an parameter. Some event rules may also contain specific parameters, which can be set with , and . parameters. Get the above information by calling the List All eventRules endpoint. It is recommended that any changes made to the are verified using the List Portfolio Event Rules Endpoint after the PUT call has been made. ### Set Portfolio Default Rules - [PUT /monitoring/portfolios/{portfolioId}/eventRules/setDefault](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/individual-portfolio-management/setportfoliodefaultrules.md): Update a portfolios event rules to default state. In Connect, default state means all rules are turned off. ### Portfolio Risk Summary - [GET /monitoring/portfolios/{portfolioId}/riskSummary](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/individual-portfolio-management/portfoliorisksummary.md): Get current portfolio risk summary information. ### List Portfolio Notifications - [GET /monitoring/portfolios/{portfolioId}/notificationEvents](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/individual-portfolio-management/listportfolionotifications.md): Get all notificationEvents based on the portfolio id, optionally filter with query parameters. ### List Company Specific NotificationEvents - [GET /monitoring/portfolios/{portfolioId}/companies/{companyId}/notificationEvents](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/individual-portfolio-management/listcompanyspecificnotificationevents.md): List of notification events based on the company id,optionally filtered with query parameters. ## Event Rules and Notifications ### List Company Events - [GET /monitoring/companies/{id}/events](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/event-rules-and-notifications/listcompanyevents.md): Endpoint to return a collection of 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 . ### All EventRules - [GET /monitoring/eventRules](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/event-rules-and-notifications/alleventrules.md): Get all available notification event rules. Notification event rules allow you to control which events you wish to monitor for the contained within a given . ### Filtered EventRules - [GET /monitoring/eventRules/{countryCode}](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/event-rules-and-notifications/filteredeventrules.md): Get all available notification event rules for the given . Notification event rules allow you to control which events you wish to monitor for the contained within a given . ### All Notification Events - [GET /monitoring/notificationEvents](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/event-rules-and-notifications/allnotificationevents.md): 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. ## Instance Management Endpoints for managing decision engine instances, including retrieval, and updating. ### Return All Available Instances - [GET /decisionEngine/instances](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/instance-management/returnallinstances.md): Returns all instances (Decision Trees) a user has permission to access. ### Return Instance Configuration - [GET /decisionEngine/instance/{guid}](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/instance-management/instanceconfiguration.md): Returns instance user has permission to access. ### Update Instance Configuration - [PUT /decisionEngine/instance/{guid}](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/instance-management/updateinstanceconfiguration.md): Update the instances information.You will need to call the endpoint to get the current configuration and then update the fields you want to change. ## Decision Trees Endpoints for accessing and managing pre-configured decision trees used for automated credit decisions. ### Return Decision Trees - [GET /decisionEngine/GUID](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/decision-trees/decisiontrees.md): Returns all decision trees that the user has permission to access. ### Return User Data Fields - [GET /decisionEngine/{provenirId}/userDataFields](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/decision-trees/userdatafields.md): Returns the user data fields defined for the given decision tree GUID. ## Decision Logs Endpoints for retrieving and managing logs of past decisions. ### Return Decision History - [GET /decisionEngine/usageLog](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/decision-logs/decisionhistory.md): Returns a log of all previously ran decisions that the user has permission to access, optionally filtered. ### Return Decision Log - [GET /decisionEngine/usageLog/{decisionLogId}](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/decision-logs/getdecisionlog.md): Returns a specified decision log for a previously ran decision. ### Update Decision Log - [PATCH /decisionEngine/usageLog/{decisionLogId}](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/decision-logs/updatedecisionlog.md): Updates the status and/or notes for a specified decision. ## Run Decision Endpoints for executing decision trees to automate credit decisions. ### Run Decision Tree - [POST /decisionEngine/{provenirId}](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/run-decision/rundecisiontree.md): Runs the provided decision tree for the given company, optionally using the data provided in the body of the call. ## Decision Outcome Endpoints for retrieving the outcomes of executed decisions, including detailed results. ### Return Decision Outcome - [GET /decisionEngine/decisionOutcome/{guid}](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/decision-outcome/decisionoutcome.md): Returns decision outcomes which is set for decision tree. ### Update Decision Outcome - [PATCH /decisionEngine/decisionOutcome/{guid}](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/decision-outcome/updatedecisionenginedecisionoutcomedetails.md): This allows the user to manually update the decision outcome ## Audit (Legacy) ### Return Protect Audit Log - [GET /protect/audits](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/audit-(legacy)/retrieveprotectauditlog.md): Returns logged interactions with Protect endpoints for audit purposes. Actions logged include creating an Investigation, Investigation Record and Schedule. ### Export Audit Log File - [POST /protect/audits](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/audit-(legacy)/exportauditlogfile.md): Produces a collection a csv of Audit records. ## IDV (Legacy) ### IDV Search - [POST /protect/idv/gdc/search](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/idv-(legacy)/idvsearch.md): Creates a search request for a GDC IDV search. ### Returns IDV Report - [GET /protect/idv/file](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/idv-(legacy)/returnsidvreport.md): Returns an IDV Report with the potential results and the sources they were matched against. ## GB Bank Match ### Bank Match - [GET /localSolutions/GB/bankmatch](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/gb-bank-match/bankmatch.md): 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. ## GB Bank Verification ### Single Request - [POST /localSolutions/GB/bankVerification/search](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/gb-bank-verification/bankverificationsearch.md): 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. ### Validate Bank Verification Request - [POST /localSolutions/GB/bankVerification/validate/{id}](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/gb-bank-verification/bankverificationvalidate.md): 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. ### Return Bank Branch Details Of A Given Sort Code - [GET /localSolutions/GB/bankVerification/sortCode/{id}](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/gb-bank-verification/sortcodecheck.md): This endpoint will return bank branch details of a given sort code. ### Request Search History - [GET /localSolutions/GB/bankVerification/history](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/gb-bank-verification/bankverificationgethistorylist.md): 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. ### Return Request History By ID - [GET /localSolutions/GB/bankVerification/history/{id}](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/gb-bank-verification/bankverificationgethistorybyid.md): This endpoint will return details of a past request by id. ### Update CustomerReference by HistoryId - [PATCH /localSolutions/GB/bankVerification/history/{id}/reference](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/gb-bank-verification/bankverificationupdatehistory.md): This endpoint will update the stored customerReference field of a past request with the provided ID. ## GB Land Registry ### GB Land Registry - [GET /localSolutions/GB/landRegistry/{companyId}](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/gb-land-registry/gblandregistry.md): Allows users to return Land Registry details of a company. ## GB Finance Agreements ### Request Finance Agreements - [GET /localSolutions/GB/CCDS/{companyId}](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/gb-finance-agreements/financeagreements.md): 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. - 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. - 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. - 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. ## FR Bank Match This endpoint provides tools for matching bank information in France. ### Bank Match - [GET /localSolutions/FR/bankmatch](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/fr-bank-match/frbankmatch.md): 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. - There are a set of 'required' parameters for this endpoint, however please note the exceptions in the description. ### Bank Match Status - [GET /localSolutions/FR/bankmatch/audition](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/fr-bank-match/frbankmatchstatus.md): This endpoint is used to check the status of a verification whose status is ‘pending’. ## DE NonLtd Companies This endpoint provides the tools for searching non-limited companies in Germany and acquiring company reports. ### DE Company Search Criteria (Non Ltd) - [GET /localSolutions/DE/nonLtdCompanies/searchcriteria](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/de-nonltd-companies/denonltdcompaniessearchcriteria.md): Provides Search Criteria DE non-ltd Companies. ### DE Company Search (Non Ltd) - [GET /localSolutions/DE/nonLtdCompanies](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/de-nonltd-companies/denonltdcompaniessearch.md): Endpoint to search for DE non-ltd Companies according to the provided Search Criteria. ### DE Company Report (Non Ltd) - [GET /localSolutions/DE/nonLtdCompanies/{id}](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/de-nonltd-companies/denonltdcompaniesreport.md): Endpoint to retrieve the DE non-ltd Company report according to the provided id. ## NL KVK Extract This endpoint provides tools for extracting information from the Dutch Chamber of Commerce (KVK). ### Return NL Extract - [GET /localSolutions/NL/extract/{kvkNumber}](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/nl-kvk-extract/extractnlkvknumber.md): NL extract from KVK Number ## US Search Support ### Fresh Investigation Request - [POST /localSolutions/US/searchSupport](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/us-search-support/createfreshinvestigationforuscountry.md): 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 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. ## Verify Verify is an exclusive add-on to Creditsafe's company credit reports, designed to assist businesses in making smarter, quicker, and more informed credit decisions. For new or small companies that lack a detailed financial footprint, Verify offers unparalleled insights by screening company directors and the individuals behind businesses for their personal financial stability and identity. Using Verify, you can confidently assess a company's leadership, using trusted public datasets that highlight potential financial concerns, such as CCJs or Insolvencies and confirm that they reside at an address on the Electoral roll. ### Return Indicator Based On Company Identififier - [GET /localSolutions/GB/verify/company/{id}](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/verify/getcompanyinformation.md): Returns an indicator as to whether verify information is available on a business. ### Execute Individual Search - [GET /localSolutions/GB/verify/individual/directReport](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/verify/getindividualdirectreport.md): Executes a search using optional personal and address details. ### Retrieve Individual Summary Information - [GET /localSolutions/GB/verify/individual/{id}/summary](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/verify/getsummaryinformationbyid.md): Returns summary information about an individual based on the provided identifier. ### Retrieve Individual Full Information - [GET /localSolutions/GB/verify/individual/{id}/full](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/verify/getfullinformationbyid.md): Returns detailed information about an individual based on the provided identifier. ## Create and View All Jobs Create a Data Cleaning job and view all jobs in the system. ### Create Job Request - [POST /dataCleaning/jobs](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/create-and-view-all-jobs/createjob.md): Enter a name for the 'Job Request' to be associated to the file going to be processed. ### Returns all Data Cleaning Jobs - [GET /dataCleaning/jobs](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/create-and-view-all-jobs/getalljobs.md): This endpoint can be used to retrieve all created data cleaning job requests as defined by the query parameters. ## Individual Job Management Manage individual Data Cleaning jobs. Including updating required mappings and enrichment processes. ### Returns Job by {id} number - [GET /dataCleaning/jobs/{id}](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/individual-job-management/getjobbyidnumber.md): Returns Job by {id} number which is generated from 'Creating Job Request' stage. This endpoint is used to check the of the job. ### Upload a Job File with an {id} - [POST /dataCleaning/jobs/{id}/upload](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/individual-job-management/jobfileuploadwithid.md): Upload a Job File for processing, you need to link to the {id} number generated from the 'Job Request'. ### Update Mappings Request - [PUT /dataCleaning/jobs/{id}/mappings](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/individual-job-management/jobupdatemappings.md): 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. ### Submit Job Request - [POST /dataCleaning/jobs/{id}/submit](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/individual-job-management/submitjobrequest.md): 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. ### Update Enrichments Request - [PUT /dataCleaning/jobs/{id}/enrichments](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/individual-job-management/updatejobenrichments.md): 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. ### Start Enrichment Request - [POST /dataCleaning/jobs/{id}/enrich](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/individual-job-management/datacleaningjobenrich.md): 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 is .Use the GET/dataCleaning/jobs/{id} to check Status of job. ### Returns Enriched Job File - [GET /dataCleaning/jobs/{id}/enrichedFile](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/individual-job-management/returnsenrichedjobfile.md): Returns the enriched file after enrichment is complete. Identify the file type to be returned via the query parameter. ### Archive Job by id - [POST /dataCleaning/jobs/{id}/archive](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/individual-job-management/archivejob.md): 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. ## Administrator Resources ### Return Profile Types - [GET /compliance/kyc-protect/profiles/types](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/administrator-resources/protectgetkycprofiletypes.md): Returns all the profile Types ### Returns Accepted Currency Codes - [GET /compliance/kyc-protect/lookup/currencyCodes](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/administrator-resources/protectgetlookupcurrencycodes.md): Returns the list of accepted currency codes. ### Return Accepted Country Codes - [GET /compliance/kyc-protect/lookup/countryCodes](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/administrator-resources/protectgetlookupcountrycodes.md): Returns the list of accepted country-codes. ### Return Profile Document Types - [GET /compliance/kyc-protect/profiles/document-types](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/administrator-resources/kycprotectgetprofiledocumenttypes.md): Returns a list of document types valid for the provided profile type. ## Audit ### Return Audit Trail - [GET /compliance/kyc-protect/audits](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/audit/compliancegetkycaudits.md): Returns a list of audits which can be filtered by various categories. ## Profile Management ### Create Profile From Company Report - [POST /compliance/kyc-protect/profiles/businesses/import](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-management/compliancepostkycprofilebusinessesimports.md): Imports a company business report into the system as a profile for compliance purposes. While this endpoint allows for significant customization during the import process, the endpoint is the as it automates much of the processing and configuration. Use this endpoint only when the preferred endpoint cannot meet your requirements. ### Create Profile - [POST /compliance/kyc-protect/profiles](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-management/kycprotectcreateprofile.md): Uses the name and type provided by the user to create a profile. ### Return Profile By Profile Id - [GET /compliance/kyc-protect/profiles/{profileId}](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-management/protectgetkycprofilesbyprofileid.md): Returns a single profile by id. ### Delete Profile By Profile Id - [DELETE /compliance/kyc-protect/profiles/{profileId}](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-management/protectdeletekycprofilesbyid.md): Deletes a single profile by id. ### Assign Profile To User - [PUT /compliance/kyc-protect/profiles/assign](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-management/protectassignprofiles.md): Assign a profile to a user ### Assigns A List Of Profiles To User - [PUT /compliance/kyc-protect/profiles/assign/bulk](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-management/kycprotectassignslistofprofilestouser.md): Assigns list of profiles to a user. ## Profile Updates ### Update Profile By Profile Id - [PUT /compliance/kyc-protect/profiles/{profileId}](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-updates/protectupdateskycprofilebyid.md): Updates a single profile by profile Id. ### Create Profile Note - [POST /compliance/kyc-protect/profiles/{profileId}/notes](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-updates/protectpostkycprofilenotes.md): Adds a note to a profile then Returns the details of the added note. ### Return Profile Notes - [GET /compliance/kyc-protect/profiles/{profileId}/notes](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-updates/protectgetkycprofilenotes.md): Returns a list of profile notes for the given profile id. ### Return Profile Notes By Note Id - [GET /compliance/kyc-protect/profiles/{profileId}/notes/{noteId}](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-updates/protectgetkycprofilenotesbynoteid.md): Returns a profile note based on profile id and note id. ### Update Profile Note By Note Id - [PUT /compliance/kyc-protect/profiles/{profileId}/notes/{noteId}](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-updates/protectupdatekycprofilenotesbynoteid.md): Updates a profile note based on profile id and note id. ### Deletes Profile Note By Note Id - [DELETE /compliance/kyc-protect/profiles/{profileId}/notes/{noteId}](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-updates/protectdeletekycprofileidbynoteid.md): Deletes a profile note based on profile id and note id. ### Add An Attachment To The Given Profile - [POST /compliance/kyc-protect/profiles/{profileId}/attachments](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-updates/kycprotectaddanattachmenttothegivenprofile.md): Adds an attachment to a profile. Returns the details of the added attachment. ### Return List Of Attachments On The Given Profile - [GET /compliance/kyc-protect/profiles/{profileId}/attachments](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-updates/kycprotectgetlistofattachmentsonthegivenprofile.md): Gets a list of attachments on the given profile ordered by modified date. ### Return A Profile Attachment By Profile And Attachment Id - [GET /compliance/kyc-protect/profiles/{profileId}/attachments/{attachmentId}](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-updates/protectgetkycprofileattachmentbyprofileidandattachmentid.md): Returns an attachment by the provided attachment Id and profile Id. ### Update Profile Attachment By Profile And Attachment Id - [PUT /compliance/kyc-protect/profiles/{profileId}/attachments/{attachmentId}](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-updates/protectputkycprofileattachmentbyprofileidandattachmentid.md): Updates A Profile Attachment By Profile And Attachment Id ### Delete Attachment By Profile And Attachment Id - [DELETE /compliance/kyc-protect/profiles/{profileId}/attachments/{attachmentId}](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-updates/protectdeletekycprofileattachmentbyprofileidandattachmentid.md): Deletes A Profile Attachment By Profile And Attachment Id ### Download Profile Attachment By Profile And Attachment Id - [GET /compliance/kyc-protect/profiles/{profileId}/attachments/{attachmentId}/download](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-updates/protectdownloadkycprofileattachmentbyprofileidandattachmentid.md): Gets profile attachment's download link. ## Profile Key Parties ### Creates A Key Party Folder Linked To The Profile Id - [POST /compliance/kyc-protect/profiles/{profileId}/keyparties](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-key-parties/compliancepostkyckeypartiesbyprofileid.md): Uses the details provided by the user to create key parties. Returns the created key parties information. ### Return All Key Party Records Linked To A Profile - [GET /compliance/kyc-protect/profiles/{profileId}/keyparties](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-key-parties/compliancegetkyckeypartiesbyprofileid.md): This endpoint will return all created Key Party folders linked to the profile id. ### Update A Batch Of Key Parties - [PUT /compliance/kyc-protect/profiles/{profileId}/keyparties](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-key-parties/complianceputkyckeypartiesbyprofileid.md): Updates a batch of key parties ### Delete a batch of key parties - [DELETE /compliance/kyc-protect/profiles/{profileId}/keyparties](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-key-parties/compliancedeletekyckeypartiesbyprofileid.md): Delete a selection of key parties from a specific profile. ### Return All Key Party Searches - [GET /compliance/kyc-protect/profiles/{profileId}/keyparties/searches](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-key-parties/compliancegetkyckeypartiessearches.md): Get profile key party searches for the user. ### Deletes A Batch Of Key Party Searches - [DELETE /compliance/kyc-protect/profiles/{profileId}/keyparties/searches](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-key-parties/compliancedeletekyckeypartiessearches.md): Delete a batch of key parties searches ### Request Multiple Searches Linked To A Key Party Asynchronously - [POST /compliance/kyc-protect/profiles/{profileId}/keyparties/searches/bulk](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-key-parties/compliancepostkyckeypartiessearchesbulkbyprofileid.md): Request multiple searches to be performed and linked to a key party asynchronously ### Links Searches To Key Parties - [POST /compliance/kyc-protect/profiles/{profileId}/keyparties/searches/link](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-key-parties/compliancepostkyckeypartiessearcheslinkbyprofileid.md): Add searches link to key parties for the current logged in user. ### Updates The Key Party By Profile Id and Key Party Id - [PUT /compliance/kyc-protect/profiles/{profileId}/keyparties/{keyPartyId}](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-key-parties/complianceprotectputkycprofileskeypartiesbyprofileidandkeypartyid.md): Updates a key party on a profile by Id. Returns the updated key party data. ### Deletes a Key PArty By Key Party Id - [DELETE /compliance/kyc-protect/profiles/{profileId}/keyparties/{keyPartyId}](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-key-parties/complianceprotectdeletekycprofileskeypartiesbyprofileidandkeypartyid.md): Delete a key party by Id. ## Batch Uploads ### Return Template For Batch Upload - [GET /compliance/kyc-protect/batchUploads/template](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/batch-uploads/compliancegetkycbatchuploadstemplate.md): This endpoint the HTTP Request is planned to be altered in the next release Returns the template to complete a batch upload. ### Request Batch Upload - [POST /compliance/kyc-protect/batchUploads](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/batch-uploads/compliancepostkycbatchuploads.md): Submits the batch file process request. Returns the details of the accepted request. ### Return A List Of Requested Uploads - [GET /compliance/kyc-protect/batchUploads](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/batch-uploads/compliancegetkycbatchuploads.md): Returns a list of uploads that have been requested. ### Return Batch Upload File Details - [GET /compliance/kyc-protect/batchUploads/{uploadId}](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/batch-uploads/compliancegetkycbatchuploadbyuploadid.md): Returns a batch Upload response as specified by the provided id. ### Download Batch Upload Error File - [GET /compliance/kyc-protect/batchUploads/{uploadId}/errors/download](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/batch-uploads/compliancegetkycbatchuploadsdownloaderrorsbyuploadid.md): Returns a link to download the error file if it has does fail during the upload this is acquired using the upload Id.. ### Retry Previous Upload - [PUT /compliance/kyc-protect/batchUploads/{uploadId}/retry](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/batch-uploads/compliancegetkycbatchuploadsretrybyuploadid.md): Re-uploads the file if it was previously failed due to 'insufficientCredits' status. ## Profile Business / Individual Details ### Return Profile Details - [GET /compliance/kyc-protect/profiles/{profileId}/details](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-business-individual-details/protectgetkycprofiledetails.md): Fetches details of a profile by profile Id. ### Update Profile Details - [PUT /compliance/kyc-protect/profiles/{profileId}/details](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-business-individual-details/protectputkycprofiledetails.md): Updates the details of profile by the profileId. ### Creates An Address For Profile - [POST /compliance/kyc-protect/profiles/{profileId}/details/addresses](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-business-individual-details/kycprotectcreatesanaddressfortheuser.md): Creates an address for the given profileId. Returns the created address information. ### Return Lists Of Addresses - [GET /compliance/kyc-protect/profiles/{profileId}/details/addresses](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-business-individual-details/kycprotectgetslistofaddresses.md): Returns list of addresses for the current logged in user based on profileId. ### Return Profile Address Details By Profile And Address Id - [GET /compliance/kyc-protect/profiles/{profileId}/details/addresses/{addressId}](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-business-individual-details/protectgetkycprofileaddressdetailsbyprofileidandaddressid.md): Returns the address by profile Id and address Id. ### Update Profile Address Details By Profile Id And Address Id - [PUT /compliance/kyc-protect/profiles/{profileId}/details/addresses/{addressId}](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-business-individual-details/protectputkycprofileaddressdetailsbyprofileidandaddressid.md): Update Profile Address Details By Profile Id And Address Id ### Delete Profile Address Details By Profile Id And Address Id - [DELETE /compliance/kyc-protect/profiles/{profileId}/details/addresses/{addressId}](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/profile-business-individual-details/protectdeletekycprofileaddressdetailsbyprofileidandaddressid.md): Deletes the address by profile Id and address id. ## AML Screening - Profile Management ### Return List Of AML Searches On The Given Profile - [GET /compliance/kyc-protect/profiles/{profileId}/searches](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-profile-management/kycprotectgetslistofsearchesonthegivenprofile.md): Returns a list of searches both business and individual associated to the profile for the profile Id. ### Deletes AML searches linked to a profile - [DELETE /compliance/kyc-protect/profiles/{profileId}/searches](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-profile-management/deletekycprofilesearchesbyprofileid.md): Deletes AML searches from a profile by profile Id and Search Id. ### Adds AML Searches To The Given Profile - [POST /compliance/kyc-protect/profiles/{profileId}/searches/link](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-profile-management/kycprotectaddsasearchtothegivenprofile.md): Adds a list of searches to a profile. ### Return All Schedules By ProfileId And Modified Date - [GET /compliance/kyc-protect/profiles/{profileId}/schedules](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-profile-management/kycprotectgetprofileschedules.md): Returns all schedules based on profileId ordered by modified date. ### Return Schedule By ProfileId And ScheduleId - [GET /compliance/kyc-protect/profiles/{profileId}/schedules/{scheduleId}](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-profile-management/kycprotectgetprofileschedulesbyscheduleid.md): Returns a schedule by profileId and scheduleId. ### Return All Hits Linked To The Profile - [GET /compliance/kyc-protect/profiles/{profileId}/amlAlerts](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-profile-management/kycprotectgetamlalertsbyprofileid.md): Returns hits of all searches linked to the profile and key parties. ### Return All Hits Of Searches Linked To A Profile - [GET /compliance/kyc-protect/profiles/{profileId}/hits](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-profile-management/getkychitsofthesearcheslinkedtoprofile.md): Return hits of the searches linked to a profile. ### Alert Metrics - [GET /compliance/kyc-protect/profiles/alerts/metrics](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-profile-management/complianceprotectgetkycprofilealertsmetrics.md): Returns a list of KYC and AML alert metrics on profiles. ## AML Screening - Businesses ### Performs An AML Search For A Business And Saves The Results To The Database - [POST /compliance/kyc-protect/searches/businesses](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-businesses/kycsearchbusiness.md): A request requires a name, at least one valid dataset, and a threshold. User will be deducted 1 credit for each AML search. ### Returns Business AML Searches - [GET /compliance/kyc-protect/searches/businesses](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-businesses/kycsearchbusinessget.md): Returns a list of business AML searches ordered by modified date. ### Update Business AML Searches - [PUT /compliance/kyc-protect/searches/businesses](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-businesses/kycsearchbusinessput.md): Updates a batch of business AML searches. ### Return Business AML Search By Search Id - [GET /compliance/kyc-protect/searches/businesses/{searchId}](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-businesses/getkycsearchbusinessbysearchid.md): Returns a single AML search based on Search id. ### Update A Business AML Search By Search Id - [PUT /compliance/kyc-protect/searches/businesses/{searchId}](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-businesses/putkycsearchbusinessbysearchid.md): Updates a business AML search. ### Return Business AML Search Hits - [GET /compliance/kyc-protect/searches/businesses/{searchId}/hits](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-businesses/getkycsearchbusinesshitsbysearchid.md): Returns the business AML search hits from the AML search results. ### Update Batch Of Business AML Search Hits - [PUT /compliance/kyc-protect/searches/businesses/{searchId}/hits](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-businesses/putkycsearchbusinesshitsbysearchid.md): Updates a batch of business AML search hits. ### Return Full AML Search Hit Information By SearchId And HitId - [GET /compliance/kyc-protect/searches/businesses/{searchId}/hits/{hitId}](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-businesses/getkycsearchbusinesshitsbysearchidandhitid.md): 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. ### Update A Single Business Hit - [PUT /compliance/kyc-protect/searches/businesses/{searchId}/hits/{hitId}](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-businesses/putkycsearchbusinessbysearchidandhitid.md): This endpoint will update a single business AML search hit by searchId and hitId. ### Download AML Details for a Hit - [GET /compliance/kyc-protect/searches/businesses/{searchId}/hits/{hitId}/download](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-businesses/compliancegetkycsearchbusinesshitsbysearchidandhitiddownload.md): 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 () from a previously performed search (). The response includes the download URL, file name, expiration timestamp, and identifiers for the search and hit. ### Download A PDF File For A Business AML Screening - [POST /compliance/kyc-protect/searches/businesses/download](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-businesses/compliancekycsearchbusinessdownload.md): 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. ### Download PDF Business Search Report - [POST /compliance/kyc-protect/searches/businesses/{searchId}/download](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-businesses/compliancegetkycsearchbusinessdownloadbysearchid.md): 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. ## AML Screening - Individuals ### Performs An AML Search For An Individual And Saves The Results To The Database - [POST /compliance/kyc-protect/searches/individuals](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-individuals/compliancekycprotectcreateindividualssearch.md): 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. ### Returns Individual AML Searches - [GET /compliance/kyc-protect/searches/individuals](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-individuals/compliancekycprotectgetindividualssearch.md): Returns a list of individual AML searches ordered by modified date. ### Update Individual AML Searches - [PUT /compliance/kyc-protect/searches/individuals](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-individuals/compliancekycprotectupdateindividualssearch.md): Updates a batch of individual AML searches. ### Return Individual AML Search By Search Id - [GET /compliance/kyc-protect/searches/individuals/{searchId}](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-individuals/getsanindividualsearchforthecurrentloggedinuserscustomerbasedonsearchid.md): Returns a single AML Search based on searchId. ### Updates An Individual AML Search By SearchID - [PUT /compliance/kyc-protect/searches/individuals/{searchId}](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-individuals/updatesanindividualsearch.md): Updates an Individual AML Search by Search Id. ### Returns Individual AML Search Hits - [GET /compliance/kyc-protect/searches/individuals/{searchId}/hits](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-individuals/getstheindividualsearchhits.md): Returns the individual AML search hits from the AML search results. ### Updates A Batch Of individual AML search Hits - [PUT /compliance/kyc-protect/searches/individuals/{searchId}/hits](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-individuals/updatesabatchofindividualhits.md): Update a batch of Individual AML Search Hits. ### Return Full AML Search Hit Information By SearchId And HitId - [GET /compliance/kyc-protect/searches/individuals/{searchId}/hits/{hitId}](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-individuals/returnsfullprofileinformationofaindividualhitbyhitid.md): 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. ### Update A Single Individual Hit - [PUT /compliance/kyc-protect/searches/individuals/{searchId}/hits/{hitId}](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-individuals/updatesingleindividualhit.md): This endpoint will update a single individual AML search hit by searchId and hitId. ### Download AML Details for a Hit - [GET /compliance/kyc-protect/searches/individuals/{searchId}/hits/{hitId}/download](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-individuals/compliancegetkycsearchindividualshitsbysearchidandhitiddownload.md): 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 () from a previously performed search (). The response includes the download URL, file name, expiration timestamp, and identifiers for the search and hit. ### Download A PDF File For An Individual AML Screening - [POST /compliance/kyc-protect/searches/individuals/download](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-individuals/compliancekycsearchindividualdownload.md): 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. ### Download PDF Business Search Report - [POST /compliance/kyc-protect/searches/individuals/{searchId}/download](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-screening-individuals/compliancegetkycsearchindividualdownloadbysearchid.md): 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 ## AML Bulk Screening ### Perform Bulk AML Screening - [POST /compliance/kyc-protect/profiles/{profileId}/searches/bulk](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-bulk-screening/compliancepostkycsearchesbulkbyprofileid.md): Request multiple searches to be performed and linked to a profile asynchronously ## AML Monitoring Management ### Add Search To AML Monitoring - [POST /compliance/kyc-protect/schedules](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-monitoring-management/kycprotectcreateschedule.md): 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. A pre-requisite for monitoring work is that any searches MUST be linked to a profile before Monitoring can be Active. ### Return All Ordered Schedules - [GET /compliance/kyc-protect/schedules](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-monitoring-management/kycprotectgetschedules.md): Returns all schedules ordered by modified date. ### Delete Searches From AML Monitoring - [DELETE /compliance/kyc-protect/schedules](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-monitoring-management/kycprotectdeleteschedules.md): Removes the specified searches from AML monitoring. ### Update Schedules - [PUT /compliance/kyc-protect/schedules](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-monitoring-management/kycprotectputschedules.md): Updates schedules in AML monitoring. ### Returns A Schedule - [GET /compliance/kyc-protect/schedules/{scheduleId}](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-monitoring-management/kycprotectgetschedulesbyscheduleid.md): Returns a schedule in AML monitoring. ### Delete A Search From AML Monitoring - [DELETE /compliance/kyc-protect/schedules/{scheduleId}](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-monitoring-management/kycprotectdeleteschedulesbyscheduleid.md): Removes a search from AML monitoring. ### Update A Schedule In Monitoring - [PUT /compliance/kyc-protect/schedules/{scheduleId}](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-monitoring-management/kycprotectputschedulesbyscheduleid.md): Updates a schedule in AML monitoring. When there is a change in threshold or datasets, the system will deduct one credit for screening. ### Return All Hits For A Schedule By Created Date - [GET /compliance/kyc-protect/schedules/amlAlerts](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/aml-monitoring-management/kycprotectgetschedulesamlalerts.md): Get all hits for an AML monitoring schedule ordered by hit created date. ## Async AML ### Return All Async AML Jobs - [GET /compliance/kyc-protect/asyncAmlJobs](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/async-aml/compliancegetkycasyncamljobs.md): Gets a list of async aml jobs for user. ### Return Async AML Jobs By Id - [GET /compliance/kyc-protect/asyncAmlJobs/{jobId}](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/async-aml/compliancegetkycasyncamljobsjobid.md): Returns a list of async aml jobs for user. ### Return Async Job Criteria By Id - [GET /compliance/kyc-protect/asyncAmlJobs/{jobId}/criteria](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/async-aml/compliancegetkycasyncamljobsjobidcriteria.md): Gets a list of job criteria by async job id for user. ## Global Monitoring ### Returns Available Country Codes - [GET /compliance/kyc-protect/lookup/kycMonitoring/countryCodes](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/global-monitoring/complianceprotectgetlookupmonitoringcountrycodes.md): Gets the list of acceptable country codes for kyc monitoring. ### Add Profiles To Monitoring - [POST /compliance/kyc-protect/kycMonitoring/profiles/bulk](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/global-monitoring/compliancepostkycmonitoringprofilesbulk.md): Adds a list of profile/s to monitoring. ### Delete Profiles From Monitoring - [DELETE /compliance/kyc-protect/kycMonitoring/profiles](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/global-monitoring/compliancedeletekycmonitoringprofiles.md): Removes list of profiles from kyc monitoring ### Return List Of Alerts By Profile - [GET /compliance/kyc-protect/kycMonitoring/profiles/{profileId}/alerts](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/global-monitoring/compliancegetkycmonitoringprofilealertsbyprofileid.md): Gets a list of kyc alerts by profile. ### Return Alert By Alert Id And ProfileId - [GET /compliance/kyc-protect/kycMonitoring/profiles/{profileId}/alerts/{alertId}](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/global-monitoring/compliancegetkycmonitoringindividualprofilealertsbyalertid.md): Gets a kyc alert associated with a given profile. ### Update Status of Alert By Profile Id And Alert Id - [PUT /compliance/kyc-protect/kycMonitoring/profiles/{profileId}/alerts/{alertId}](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/global-monitoring/complianceputkycmonitoringindividualprofilealertsbyalertid.md): Updates a kyc alert associated with a given profile ## Reporting ### Retrieve Report Criteria - [GET /compliance/kyc-protect/reports/criteria/{type}](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/reporting/compliancegetkyccriteriabytype.md): 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 property in the request. Use this to retrieve a list of valid fields for the report type before proceeding with report creation. ### Create AML / Audit Report - [POST /compliance/kyc-protect/reports](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/reporting/compliancepostkycreports.md): Uses the user-provided information to create a compliance report. The property in the request body must be populated using the fields returned by the endpoint. Ensure you first retrieve the criteria for the desired report type using the endpoint before making this request. ### Retrieve a Single Report by ID - [GET /compliance/kyc-protect/reports/{reportId}](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/reporting/compliancegetkycreportsbyreportid.md): Fetches the details of a single compliance report identified by its unique . 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., , , ). Ensure that the provided corresponds to an existing report in the system. ### Download a Report by ID - [GET /compliance/kyc-protect/reports/{reportId}/download](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/reporting/compliancegetdownloadkycreportsbyreportid.md): Retrieves the download information for a specific compliance report identified by its unique . 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 corresponds to a valid and completed report in the system. ## Consumers Update this description. ### Consumer Report - [GET /consumers](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/consumers/consumerreport.md): 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. ### Consumer Search Criteria - [GET /consumers/searchcriteria](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/consumers/consumersearchcriteria.md): Returns country specific fields that can be used to search for a Consumer. ### Return Custom Report Parameters - [GET /reportcustomdata/{country}](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/connect-api-full/connectapi/consumers/customreportparameters.md): Returns the allowed values of the customData parameter. Used in the . I.e. Supplying 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 = .