Skip to content

Linkcy Api (1.114.5)

Overview

This is the partner API from linkcy. Here you can find our API documentation.

LinkCy API allows you to create fully embedded banking products for your own company or consumers. This API is backed by all mandatory requirements by financial authorities. To process, information provided into the API must be accurate.

Authentication

You can obtain a LinkCy Authorization Key by contacting our commercial team here.

Download OpenAPI description
sandbox.json
sandbox.yaml
Overview
URL
https://linkcy.io/#contact
Languages
Servers
Generated server url
https://api.sandbox.linkcy.cloud/

Authentication

Operations

Strong Authentication

Operations

Partner

Operations

Webhook

Operations

End-user

Operations

Consumer

The consumer represents the individual partner client. It must have a valid phone number and be formally identified with a KYC procedure before carrying out any operation.

Operations

Corporate

Operations

KYC

Operations

KYB

Operations

Documents

Operations

List documents

Request

List the documents for a specific end-user.

The documents will be downloaded with a dedicated endpoint.

Security
Linkcy-Auth
Query
sortAttributestring
Enum"TYPE""FRIENDLY_NAME""FILENAME""CREATION_DATE"
endUserIdstring(uuid)
typestring
Enum"ARTICLE_OF_ASSOCIATION""BANK_ACCOUNT_DETAILS""BANK_ACCOUNT_STATEMENT""COMPANY_INCORPORATION""COMPANY_REGISTRY_EXTRACT""DILIGENCE_REVIEW""DIRECT_DEBIT_MANDATE""DRIVING_LICENCE""FAMILY_RECORD_BOOK""HEALTH_INSURANCE"
statusArray of strings
Items Enum"UPLOADED""REQUESTED""DECLINED""VALIDATED"
requestedboolean
transactionIdstring(uuid)
beneficiaryIdstring(uuid)
corporateRelatedIdstring(uuid)
addressIdstring(uuid)
pageSizeinteger(int32)<= 100

The size of the page to be returned.

pageinteger(int32)[ 0 .. 500 ]

The page number.

sortDirectionstring
Enum"ASC""DESC"
No request payload

Responses

OK

Bodyapplication/json
contentArray of objects(DocumentListElementDto_Partner)required
content[].​idstring(uuid)required
content[].​endUserobject(End-user)required
content[].​endUser.​idstring(uuid)required
content[].​friendlyNamestring
content[].​fileNamestring
content[].​typestringrequired
Enum"ARTICLE_OF_ASSOCIATION""BANK_ACCOUNT_DETAILS""BANK_ACCOUNT_STATEMENT""COMPANY_INCORPORATION""COMPANY_REGISTRY_EXTRACT""DILIGENCE_REVIEW""DIRECT_DEBIT_MANDATE""DRIVING_LICENCE""FAMILY_RECORD_BOOK""HEALTH_INSURANCE"
content[].​statusstringrequired
Enum"UPLOADED""REQUESTED""DECLINED""VALIDATED"
content[].​transactionIdstring(uuid)

ID of the transaction if the document is a TRANSACTION_RECEIPT or any document related to a transaction.

content[].​beneficiaryIdstring(uuid)

ID of the beneficiary associated with the document.

content[].​corporateRelatedIdstring(uuid)

ID of the corporate related associated with the document.

content[].​addressIdstring(uuid)

ID of the address associated with the document.

content[].​requestedbooleanrequired
content[].​creationDatestring(date-time)required
totalElementsinteger(int64)required
Example: 1
pageinteger(int32)required

The page number.

pageSizeinteger(int32)required

The requested page size.

Response
application/json
{
  "content": [
    { … }
  ],
  "totalElements": 1,
  "page": 0,
  "pageSize": 0
}

Upload a document

Request

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.
Security
Linkcy-Auth
Bodymultipart/form-data
endUserIdstring(uuid)

The id of the end-user, can be a consumer or corporate. Mandatory if not authenticated as end-user.

typestring(DocumentType)
Enum"ARTICLE_OF_ASSOCIATION""BANK_ACCOUNT_DETAILS""BANK_ACCOUNT_STATEMENT""COMPANY_INCORPORATION""COMPANY_REGISTRY_EXTRACT""DIRECT_DEBIT_MANDATE""DRIVING_LICENCE""FAMILY_RECORD_BOOK""HEALTH_INSURANCE""IDENTITY_CARD"
documentIdstring(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.

transactionIdstring(uuid)

ID of the transaction if the document is a TRANSACTION_RECEIPT or any document related to a transaction.

beneficiaryIdstring(uuid)

ID of the beneficiary associated with the document.

addressIdstring(uuid)

ID of the address associated with the document.

corporateRelatedIdstring(uuid)

ID of the corporate related associated with the document.

friendlyNamestring[ 1 .. 255 ] characters
filestring(binary)required
multipart/form-data
{
  "endUserId": "120e9d1f-8444-4b91-85e8-5b208615a3e5",
  "type": "ARTICLE_OF_ASSOCIATION",
  "documentId": "4704590c-004e-410d-adf7-acb7ca0a7052",
  "transactionId": "75906707-8c31-479c-b354-aa805c4cefbc",
  "beneficiaryId": "410e5c37-9603-4e5b-81b1-7cb895f362e8",
  "addressId": "785d1fc4-8ab5-48f1-8685-117cac9865d6",
  "corporateRelatedId": "f2c36984-cb53-436d-84e1-092eab51bcc5",
  "friendlyName": "string",
  "file": "string"
}

Responses

Created

Bodyapplication/json
idstring(uuid)required
Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

Create a document request

Request

Create a document request for an end-user so they can upload the required document.

Security
Linkcy-Auth
Bodyapplication/jsonrequired
endUserIdstring(uuid)required

The id of the end-user, can be a consumer or corporate. Mandatory if not authenticated as end-user.

typestring(DocumentType)required
Enum"ARTICLE_OF_ASSOCIATION""BANK_ACCOUNT_DETAILS""BANK_ACCOUNT_STATEMENT""COMPANY_INCORPORATION""COMPANY_REGISTRY_EXTRACT""DIRECT_DEBIT_MANDATE""DRIVING_LICENCE""FAMILY_RECORD_BOOK""HEALTH_INSURANCE""IDENTITY_CARD"
notestring
transactionIdstring(uuid)

ID of the transaction if the document is a TRANSACTION_RECEIPT or any document related to a transaction.

beneficiaryIdstring(uuid)
corporateRelatedIdstring(uuid)
addressIdstring(uuid)
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",
  "corporateRelatedId": "f2c36984-cb53-436d-84e1-092eab51bcc5",
  "addressId": "785d1fc4-8ab5-48f1-8685-117cac9865d6"
}

Responses

Created

Bodyapplication/json
idstring(uuid)required
Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

Ledger

Operations

Card

Operations

Acquiring

Operations

Beneficiary

Operations

Transaction

Operations

Direct Debit Mandate

Operations

Wallet

Operations

Crypto Beneficiary

Operations

Crypto Transaction

Operations

Additional

Operations

Sandbox

Operations

Web Pages

Operations