Skip to content
Connect API Catalog/
/
/
Delete Profile Note By No...

KYC (Know Your Customer) (1.0.0)

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.

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.

Download OpenAPI description
kycProtect.json
kycProtect.yaml
Languages
Servers
Sandbox server

https://connect.sandbox.creditsafe.com/v1/

Production server

https://connect.creditsafe.com/v1/

Authentication

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

Operations

Administrator Resources

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

Operations

Audit

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

Operations

Profile Management

Endpoints to create, retrieve, and manage profiles.

Operations

Profile Updates

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

Operations

Update Profile Note By Note Id

Request

Updates a profile note based on profile id and note id.

Security
bearerToken
Path
profileIdstringrequired

Id of a profile.

Example: 9a7ae0c8-f473-4ab6-8dbb-03fc061630cc
noteIdstringrequired

Id of a note.

Example: 047ae398-7639-40af-911e-cc214cf3045c
Bodyapplication/json
bodystring or null

The body of the note to be added. Limited to 1000 characters

Example: "testing"
isArchivedboolean
Example: true
curl -i -X PUT \
  https://connect.sandbox.creditsafe.com/v1/compliance/kyc-protect/profiles/9a7ae0c8-f473-4ab6-8dbb-03fc061630cc/notes/047ae398-7639-40af-911e-cc214cf3045c \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "body": "testing",
    "isArchived": true
  }'

Responses

Bodyapplication/json
idstring(uuid)

Id of the note

bodystring

Body of the note

isArchivedboolean

Value indicating whether the note is archived

createdAtstring(date-time)

Note created time

createdByIdinteger(int32)

Id of the user who created note

createdBystring

Name of the user who created note

modifiedAtstring(date-time)

Note last updated time

modifiedByIdinteger(int32)

Id of the user who last modified the note

modifiedBystring

Name of the user who last modified the note

Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "body": "string",
  "isArchived": true,
  "createdAt": "2019-08-24T14:15:22Z",
  "createdById": 0,
  "createdBy": "string",
  "modifiedAt": "2019-08-24T14:15:22Z",
  "modifiedById": 0,
  "modifiedBy": "string"
}

Delete Profile Note By Note Id

Request

Deletes a profile note based on profile id and note id.

Security
bearerToken
Path
profileIdstringrequired

Id of a profile.

Example: 9a7ae0c8-f473-4ab6-8dbb-03fc061630cc
noteIdstringrequired

Id of a note.

Example: 047ae398-7639-40af-911e-cc214cf3045c
curl -i -X DELETE \
  https://connect.sandbox.creditsafe.com/v1/compliance/kyc-protect/profiles/9a7ae0c8-f473-4ab6-8dbb-03fc061630cc/notes/047ae398-7639-40af-911e-cc214cf3045c \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

No Content

Response
No content

Add An Attachment To The Given Profile

Request

Adds an attachment to a profile. Returns the details of the added attachment.

Security
bearerToken
Path
profileIdstring(uuid)required

id of the profile

Bodymultipart/form-data
Filestring(binary)

The attachment to be added. Size Limited to 50MB.

DocumentTypestring

The document type of the attachment

Descriptionstring

The description of the attachment. Limited to 250 characters.

curl -i -X POST \
  'https://connect.sandbox.creditsafe.com/v1/compliance/kyc-protect/profiles/{profileId}/attachments' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: multipart/form-data' \
  -F File=string \
  -F DocumentType=string \
  -F Description=string

Responses

Created

Bodyapplication/json
idstring(uuid)

Attachment Id.

fileNamestring

Example:passport.pdf (Attachment Name).

fileSizeInBytesinteger(int64)

Size of the attachment in bytes.

documentTypestring

Document type of the attachment.

descriptionstring

Description of the attachment.

createdAtstring(date-time)

Attachment uploaded time.

createdByIdinteger(int32)

Attachment uploaded by user id

createdBystring

Attachment uploaded by user

modifiedAtstring(date-time)

Attachment modified time

modifiedByIdinteger(int32)

Attachment modified by user id

modifiedBystring

Attachment modified by user

Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "fileName": "string",
  "fileSizeInBytes": 0,
  "documentType": "string",
  "description": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "createdById": 0,
  "createdBy": "string",
  "modifiedAt": "2019-08-24T14:15:22Z",
  "modifiedById": 0,
  "modifiedBy": "string"
}

Profile Key Parties

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

Operations

Profile Business / Individual Details

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

Operations

AML Screening - Profile Management

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

Operations

AML Screening - Businesses

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

Operations

AML Screening - Individuals

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

Operations

AML Bulk Screening

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

Operations

AML Monitoring Management

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

Operations

Async AML

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

Operations

Batch Uploads

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

Operations

Global Monitoring

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

Operations

Reporting

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

Operations

Searches

Endpoint to review performed searches for businesses or individuals, including retrieving search results and downloading reports.

Operations

Compliance Alerts

Endpoints to manage and retrieve compliance alerts related to companies via a connectId.

Operations