Skip to content

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
Languages
Servers
Generated server url
https://api.sandbox.linkcy.cloud/
Operations
Operations
Operations
Operations
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
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations

Request

Fetch all crypto wallets based on parameters.

Security
Linkcy-Auth
Query
sortAttributestring
Enum"CREATION_DATE""UPDATE_DATE""FRIENDLY_NAME"
endUserIdstring(uuid)

The ID of the end-user. If empty, the query will return results for all end-users.

statusstring
Enum"PENDING""ACTIVE""CLOSED""FAILED"
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(CryptoWalletListResponseElementDto_Partner)required
content[].​idstring(uuid)required
content[].​blockchainstringrequired
Enum"BITCOIN""ETHEREUM""BNB_SMART_CHAIN"
content[].​statusstringrequired
Enum"PENDING""ACTIVE""CLOSED""FAILED"
content[].​friendlyNamestring
content[].​addressstring
content[].​creationDatestring(date-time)required
content[].​updateDatestring(date-time)required
content[].​endUserIdstring(uuid)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 }

Request

Create a crypto wallet.

Security
Linkcy-Auth
Bodyapplication/jsonrequired
endUserIdstring(uuid)

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

friendlyNamestring[ 0 .. 90 ] charactersrequired
blockchainstringrequired
Enum"BITCOIN""ETHEREUM""BNB_SMART_CHAIN"
application/json
{ "endUserId": "120e9d1f-8444-4b91-85e8-5b208615a3e5", "friendlyName": "string", "blockchain": "BITCOIN" }

Responses

Created

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

Request

Get all information about a crypto wallet using its ID.

Security
Linkcy-Auth
Path
walletIdstring(uuid)required
Query
verifiedContractsOnlyboolean
No request payload

Responses

OK

Bodyapplication/json
idstring(uuid)required
blockchainstringrequired
Enum"BITCOIN""ETHEREUM""BNB_SMART_CHAIN"
statusstringrequired
Enum"PENDING""ACTIVE""CLOSED""FAILED"
friendlyNamestring
addressstring
creationDatestring(date-time)required
updateDatestring(date-time)required
endUserIdstring(uuid)required
assetsArray of objects(CryptoAsset_Partner)uniquerequired
assets[].​symbolstringrequired
assets[].​decimalsinteger(int32)required
assets[].​blockchainstringrequired
Enum"BITCOIN""ETHEREUM""BNB_SMART_CHAIN"
assets[].​balancestringrequired
assets[].​contractstring
assets[].​namestring
assets[].​verifiedboolean
Response
application/json
{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "blockchain": "BITCOIN", "status": "PENDING", "friendlyName": "string", "address": "string", "creationDate": "2019-08-24T14:15:22Z", "updateDate": "2019-08-24T14:15:22Z", "endUserId": "120e9d1f-8444-4b91-85e8-5b208615a3e5", "assets": [ {} ] }
Operations
Operations
Operations
Operations
Operations