Skip to 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
{ "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" }