# KYC Compliance

KYC (Know Your Customer) enables you to make better-informed risk
management decisions by utilizing our comprehensive business information.
This service is designed for both Know Your Business operations and AML
(Anti-Money Laundering) screening features. <br><br> The application
ensures that you can conduct due diligence on customers and suppliers
alike, identify key parties, verify individual  identity details globally,
and screen against international sanctions, regulatory enforcements, PEP
(Politically Exposed Persons) lists,  and potential adverse media.


Version: 1.0.0
Metadata:
  - tags: ["Featured"]

## 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

[KYC Compliance](https://doc.creditsafe.com/_spec/connect-apis-catalog/product-catalog/KYCProtect/kycProtect.yaml)

## Authentication

Endpoints to authenticate and generate an authentication token for secure access to the API.

### Authenticate

 - [POST /authenticate](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/kycprotect/kycprotect/authentication/authenticate.md): Supply username and password to generate Authentication Token.
  


## Administrator Resources

Endpoints for managing administrative tasks, such as user roles, currency codes, country codes and profile document types.

### Return Profile Types

 - [GET /compliance/kyc-protect/profiles/types](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/kycprotect/kycprotect/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/kycprotect/kycprotect/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/kycprotect/kycprotect/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/kycprotect/kycprotect/administrator-resources/kycprotectgetprofiledocumenttypes.md): Returns a list of document types valid for the provided profile type.

## Audit

Endpoints to retrieve audit logs and track activity related to profiles, searches, and monitoring actions.

### Return Audit Trail

 - [GET /compliance/kyc-protect/audits](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/kycprotect/kycprotect/audit/compliancegetkycaudits.md): Returns a list of audits which can be filtered by various categories.

## Profile Management

Endpoints to create, retrieve, and manage profiles.

### Create Profile From Company Report

 - [POST /compliance/kyc-protect/profiles/businesses/import](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/kycprotect/kycprotect/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/kycprotect/kycprotect/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/kycprotect/kycprotect/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/kycprotect/kycprotect/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/kycprotect/kycprotect/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/kycprotect/kycprotect/profile-management/kycprotectassignslistofprofilestouser.md): Assigns list of profiles to a user.

## Profile Updates

Endpoints to update existing profiles with new information, such as addresses, notes, or attachments.

### Update Profile By Profile Id

 - [PUT /compliance/kyc-protect/profiles/{profileId}](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/kycprotect/kycprotect/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/kycprotect/kycprotect/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/kycprotect/kycprotect/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/kycprotect/kycprotect/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/kycprotect/kycprotect/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/kycprotect/kycprotect/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/kycprotect/kycprotect/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/kycprotect/kycprotect/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/kycprotect/kycprotect/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/kycprotect/kycprotect/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/kycprotect/kycprotect/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/kycprotect/kycprotect/profile-updates/protectdownloadkycprofileattachmentbyprofileidandattachmentid.md): Gets profile attachment's download link.

## Profile Key Parties

Endpoints to manage key parties associated with a profile, such as directors, shareholders, or UBOs.

### 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/kycprotect/kycprotect/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/kycprotect/kycprotect/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/kycprotect/kycprotect/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/kycprotect/kycprotect/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/kycprotect/kycprotect/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/kycprotect/kycprotect/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/kycprotect/kycprotect/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/kycprotect/kycprotect/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/kycprotect/kycprotect/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/kycprotect/kycprotect/profile-key-parties/complianceprotectdeletekycprofileskeypartiesbyprofileidandkeypartyid.md): Delete a key party by Id.

## Profile Business / Individual Details

Endpoints to retrieve detailed information about businesses or individuals associated with a profile.

### Return Profile Details

 - [GET /compliance/kyc-protect/profiles/{profileId}/details](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/kycprotect/kycprotect/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/kycprotect/kycprotect/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/kycprotect/kycprotect/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/kycprotect/kycprotect/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/kycprotect/kycprotect/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/kycprotect/kycprotect/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/kycprotect/kycprotect/profile-business-individual-details/protectdeletekycprofileaddressdetailsbyprofileidandaddressid.md): Deletes the address by profile Id and address id.

## AML Screening - Profile Management

Endpoints to manage AML screening profiles, including creating, updating, and retrieving screening results.

### 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/kycprotect/kycprotect/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/kycprotect/kycprotect/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/kycprotect/kycprotect/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/kycprotect/kycprotect/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/kycprotect/kycprotect/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/kycprotect/kycprotect/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/kycprotect/kycprotect/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/kycprotect/kycprotect/aml-screening-profile-management/complianceprotectgetkycprofilealertsmetrics.md): Returns a list of KYC and AML alert metrics on profiles.

## AML Screening - Businesses

Endpoints to perform AML screening for businesses, including risk assessments and compliance checks.

### 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/kycprotect/kycprotect/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/kycprotect/kycprotect/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/kycprotect/kycprotect/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/kycprotect/kycprotect/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/kycprotect/kycprotect/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/kycprotect/kycprotect/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/kycprotect/kycprotect/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/kycprotect/kycprotect/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/kycprotect/kycprotect/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/kycprotect/kycprotect/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/kycprotect/kycprotect/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/kycprotect/kycprotect/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

Endpoints to perform AML screening for individuals, including identity verification and risk assessments.

### 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/kycprotect/kycprotect/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/kycprotect/kycprotect/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/kycprotect/kycprotect/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/kycprotect/kycprotect/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/kycprotect/kycprotect/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/kycprotect/kycprotect/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/kycprotect/kycprotect/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/kycprotect/kycprotect/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/kycprotect/kycprotect/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/kycprotect/kycprotect/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/kycprotect/kycprotect/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/kycprotect/kycprotect/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

Endpoints to perform bulk AML screenings for multiple businesses or individuals in a single request.

### Perform Bulk AML Screening

 - [POST /compliance/kyc-protect/profiles/{profileId}/searches/bulk](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/kycprotect/kycprotect/aml-bulk-screening/compliancepostkycsearchesbulkbyprofileid.md): Request multiple searches to be performed and linked to a profile asynchronously

## AML Monitoring Management

Endpoints to set up and manage ongoing AML monitoring for profiles, including receiving alerts for changes or risks.

### Add Search To AML Monitoring

 - [POST /compliance/kyc-protect/schedules](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/kycprotect/kycprotect/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/kycprotect/kycprotect/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/kycprotect/kycprotect/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/kycprotect/kycprotect/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/kycprotect/kycprotect/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/kycprotect/kycprotect/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/kycprotect/kycprotect/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/kycprotect/kycprotect/aml-monitoring-management/kycprotectgetschedulesamlalerts.md): Get all hits for an AML monitoring schedule ordered by hit created date.

## Async AML

Endpoints to return asynchronous AML jobs, such as bulk screenings or monitoring tasks.

### Return All Async AML Jobs

 - [GET /compliance/kyc-protect/asyncAmlJobs](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/kycprotect/kycprotect/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/kycprotect/kycprotect/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/kycprotect/kycprotect/async-aml/compliancegetkycasyncamljobsjobidcriteria.md): Gets a list of job criteria by async job id for user.

## Batch Uploads

Endpoints to upload and process batch files for profiles or searches, including retrying failed uploads and downloading error reports.

### Return Template For Batch Upload

 - [GET /compliance/kyc-protect/batchUploads/template](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/kycprotect/kycprotect/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/kycprotect/kycprotect/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/kycprotect/kycprotect/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/kycprotect/kycprotect/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/kycprotect/kycprotect/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/kycprotect/kycprotect/batch-uploads/compliancegetkycbatchuploadsretrybyuploadid.md): Re-uploads the file if it was previously failed due to 'insufficientCredits' status.

## Global Monitoring

Endpoints to monitor changes to company information globally, including event rules and notifications.

### Returns Available Country Codes

 - [GET /compliance/kyc-protect/lookup/kycMonitoring/countryCodes](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/kycprotect/kycprotect/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/kycprotect/kycprotect/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/kycprotect/kycprotect/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/kycprotect/kycprotect/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/kycprotect/kycprotect/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/kycprotect/kycprotect/global-monitoring/complianceputkycmonitoringindividualprofilealertsbyalertid.md): Updates a kyc alert associated with a given profile

## Reporting

Endpoints to generate and retrieve reports, including compliance reports and risk assessments.

### Retrieve Report Criteria

 - [GET /compliance/kyc-protect/reports/criteria/{type}](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/kycprotect/kycprotect/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/kycprotect/kycprotect/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/kycprotect/kycprotect/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/kycprotect/kycprotect/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.