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_STATEMENT" "COMPANY_INCORPORATION" "DRIVING_LICENCE" "HEALTH_INSURANCE" … 17 more
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 10 file 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
required
string (DocumentType) 
 Enum: "ARTICLE_OF_ASSOCIATION" "BANK_ACCOUNT_STATEMENT" "COMPANY_INCORPORATION" "DRIVING_LICENCE" "HEALTH_INSURANCE" … 16 more 
friendlyName
string  [ 0 .. 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"
}
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",
  • "type": "ARTICLE_OF_ASSOCIATION",
  • "fileName": "string",
  • "endUser": {
    },
  • "friendlyName": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "download": {
    },
  • "contentType": "string"
}
➔ Next to Ledger