Skip to content
Connect API Catalog/
/
/
Return List Of Attachment...

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

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"
}

Return List Of Attachments On The Given Profile

Request

Gets a list of attachments on the given profile ordered by modified date.

Security
bearerToken
Path
profileIdstring(uuid)required

id of the profile

Query
pageinteger(int32)

The page number to fetch. Should be a positive integer.

pageSizeinteger

Specifies the number of items to be displayed per page. Allowed values are between 1 and 100.

curl -i -X GET \
  'https://connect.sandbox.creditsafe.com/v1/compliance/kyc-protect/profiles/{profileId}/attachments?page=0&pageSize=0' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json
totalSizeinteger(int32)
itemsArray of objects(KycProtectProfileGetAttachmentResponse)
Response
application/json
{
  "totalSize": 0,
  "items": [
    { … }
  ]
}

Return A Profile Attachment By Profile And Attachment Id

Request

Returns an attachment by the provided attachment Id and profile Id.

Security
bearerToken
Path
profileIdstring(uuid)required

Id of a profile.

Example: 9a7ae0c8-f473-4ab6-8dbb-03fc061630cc
attachmentIdstring(uuid)required

Id of an attachment.

Example: 24faad02-7e20-4912-bdd9-51e4797380c5
curl -i -X GET \
  https://connect.sandbox.creditsafe.com/v1/compliance/kyc-protect/profiles/9a7ae0c8-f473-4ab6-8dbb-03fc061630cc/attachments/24faad02-7e20-4912-bdd9-51e4797380c5 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

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 or null

Description of the attachment.

createdAtstring(date-time)

Attachment uploaded time.

createdByIdinteger(int32)

Attachment uploaded by user id

createdBystring

Attachment uploaded by user

modifiedAtstring or null(date-time)

Attachment modified time

modifiedByIdinteger or null(int32)

Attachment modified by user id

modifiedBystring or null

Attachment modified by user

linkedTostring or null

The profile component to which current attachment is linked to.

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",
  "linkedTo": "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