LinkCy

Documents

List documents

List the documents for a specific end-user.

The documents will be downloaded with a dedicated endpoint.

SecurityLinkcy-Auth
Request
query Parameters
sortAttribute
string
Enum: "TYPE" "FRIENDLY_NAME" "FILENAME" "CREATION_DATE"
endUserId
string <uuid>
type
string
Enum: "ARTICLE_OF_ASSOCIATION" "BANK_ACCOUNT_DETAILS" "BANK_ACCOUNT_STATEMENT" "COMPANY_INCORPORATION" "COMPANY_REGISTRY_EXTRACT" … 23 more
status
Array of strings
Items Enum: "UPLOADED" "REQUESTED" "DECLINED" "VALIDATED"
requested
boolean
beneficiaryId
string <uuid>
transactionId
string <uuid>
pageSize
integer <int32> <= 100

The size of the page to be returned.

page
integer <int32> >= 0

The page number.

sortDirection
string
Enum: "ASC" "DESC"
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

get/api/partner/documents
Request samples 
Response samples 
application/json
{
  • "content": [
    ],
  • "totalElements": 1,
  • "page": 0,
  • "pageSize": 0
}
Upload a document
Upload a document for a specific end-user. To prevent abuse:


    

  • File size must be less than 5MB.
    • 

  • There is a limit of files per end-user.
    • 



SecurityLinkcy-Auth 
Request 
Request Body schema: multipart/form-data
endUserId
string <uuid> 
The id of the end-user, can be a consumer or corporate. Mandatory if not authenticated as end-user.


 
type
string (DocumentType) 
 Enum: "ARTICLE_OF_ASSOCIATION" "BANK_ACCOUNT_DETAILS" "BANK_ACCOUNT_STATEMENT" "COMPANY_INCORPORATION" "COMPANY_REGISTRY_EXTRACT" … 22 more 
documentId
string <uuid> 
Use this field if the document you want to upload was requested (status REQUESTED).


Note: you do not need to fill endUserId and type fields when you upload a requested document.


 
transactionId
string <uuid> 
ID of the transaction if the document is a TRANSACTION_RECEIPT or any document related to a transaction.


 
beneficiaryId
string <uuid> 
ID of the beneficiary associated with the document.


 
friendlyName
string  [ 1 .. 255 ] characters 
 
file
required
string <binary> 
 
Responses 
201
Created


400
Bad Request


401
Unauthorized


403
Forbidden


409
Conflict


post/api/partner/documents
Request samples 
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
Create a document request
Create a document request for an end-user so they can upload the required document.


SecurityLinkcy-Auth 
Request 
Request Body schema: application/json
required
endUserId
required
string <uuid> 
The id of the end-user, can be a consumer or corporate. Mandatory if not authenticated as end-user.


 
type
required
string (DocumentType) 
 Enum: "ARTICLE_OF_ASSOCIATION" "BANK_ACCOUNT_DETAILS" "BANK_ACCOUNT_STATEMENT" "COMPANY_INCORPORATION" "COMPANY_REGISTRY_EXTRACT" … 22 more 
note
string
 
transactionId
string <uuid> 
ID of the transaction if the document is a TRANSACTION_RECEIPT or any document related to a transaction.


 
beneficiaryId
string <uuid> 
 
Responses 
201
Created


400
Bad Request


401
Unauthorized


403
Forbidden


post/api/partner/documents/requests
Request samples 
application/json
{
  • "endUserId": "120e9d1f-8444-4b91-85e8-5b208615a3e5",
  • "type": "ARTICLE_OF_ASSOCIATION",
  • "note": "string",
  • "transactionId": "75906707-8c31-479c-b354-aa805c4cefbc",
  • "beneficiaryId": "410e5c37-9603-4e5b-81b1-7cb895f362e8"
}
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
Get a document
Get a document with its download link.


SecurityLinkcy-Auth 
Request 
path Parameters
documentId
required
string <uuid> 
 
Responses 
200
OK


400
Bad Request


401
Unauthorized


403
Forbidden


404
Not Found


get/api/partner/documents/{documentId}
Request samples 
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "endUser": {
    },
  • "contentType": "string",
  • "type": "ARTICLE_OF_ASSOCIATION",
  • "friendlyName": "string",
  • "fileName": "string",
  • "status": "UPLOADED",
  • "transactionId": "75906707-8c31-479c-b354-aa805c4cefbc",
  • "beneficiaryId": "410e5c37-9603-4e5b-81b1-7cb895f362e8",
  • "requested": true,
  • "note": "string",
  • "verificationDate": "2019-08-24T14:15:22Z",
  • "uploadDate": "2019-08-24T14:15:22Z",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "download": {
    }
}
➔ Next to Ledger