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

Ledger

Operations

Card

Operations

Acquiring

Operations

Beneficiary

Operations

Transaction

Operations

Direct Debit Mandate

Operations

Wallet

Operations

Crypto Beneficiary

Operations

List Crypto Beneficiaries

Request

Fetch all your crypto beneficiaries.

Security
Linkcy-Auth
Query
activeboolean

Show results with only active status or non active status. Both statuses are shown by default.

displayboolean

Show only display or non display beneficiaries. Both statuses are shown by default.

sortAttributestring
Enum"NAME""CREATION_DATE"
endUserIdstring(uuid)

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

statusstring
Enum"DECLINED""PENDING_REVIEW""VALID""PENDING""NEED_ADDITIONAL_INFORMATION"
blockchainTypestring
Enum"BITCOIN""ETHEREUM""BNB_SMART_CHAIN"
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(CryptoBeneficiaryResponseDto_Partner)required
content[].​idstring(uuid)required
content[].​namestringrequired
content[].​friendlyNamestring
content[].​typestringrequired
Enum"PERSON""COMPANY"
content[].​creationDatestring(date-time)required
content[].​updateDatestring(date-time)required
content[].​activebooleanrequired
content[].​displaybooleanrequired
content[].​statusstringrequired
Enum"DECLINED""PENDING_REVIEW""VALID""PENDING""NEED_ADDITIONAL_INFORMATION"
content[].​walletDetailsobject(WalletDetails_Partner)required
content[].​walletDetails.​addressstringrequired

Counterparty wallet address.

content[].​walletDetails.​blockchainstringrequired

Counterparty wallet blockchain. The enumeration is the same as the one in Create Wallet endpoint because you can only create transactions on the same blockchain as the wallet sender.

Enum"BITCOIN""ETHEREUM""BNB_SMART_CHAIN"
content[].​walletDetails.​typestringrequired
Enum"CUSTODIAL""NON_CUSTODIAL"
content[].​walletDetails.​providerstring

Optional, used only for CUSTODIAL wallets.

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
}

Add a new crypto-beneficiary

Request

Create a crypto beneficiary in order to send digital assets.

This operation might require SCA.

Security
Linkcy-Auth
Headers
Linkcy-SCA-Strategystring

The strategy to use when a SCA is required:

More information:
  • PUSH_NOTIFICATION: will send a notification if the SCA is required.
  • DATA_SIGNING: Linkcy-SCA-Signature header must contain signature provided by PowerAuth Mobile SDK on registered device.
  • BY_PASS: Sandbox only - will ignore any SCA if used.
Error Codes
  • 409 Conflict
    • SCA_REQUIRED: The operation you are trying to do requires SCA, current strategy {0}.
Default PUSH_NOTIFICATION
Enum"PUSH_NOTIFICATION""DATA_SIGNING""BY_PASS"
Linkcy-SCA-Signaturestring

The signature that needs to be validated, it is generated from data signing.

More information:
  • Signature will be verified against wultra.
  • Operation will be denied if signature is not valide.
  • Avoid creating multiple signature at same time for the same registration.
  • Signature TTL is 30 sec.
Error Codes
  • 401 Forbidden
    • SCA_SIGNATURE_DOES_NOT_MATCH: The sca signature provided doesn't match the one required for this operation
  • 404 Not Found
    • NO_ACTIVE_SCA_DEVICE_FOUND: No active SCA device could be found.
  • 409 Conflict
    • SCA_DEVICE_NOT_VALID: The device cannot be used to sign this data.
    • SCA_SIGNATURE_FORMAT_INVALID: The signature format for data signing SCA strategy is invalid: HTTP header validation failed.
    • SCA_SIGNATURE_MISSING: The signature required for data signing SCA strategy is missing.
  • 500 Internal Server Error
    • SCA_UNEXPECTED_ERROR: Unable to perform SCA operation
Bodyapplication/jsonrequired
endUserIdstring(uuid)

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

typestringrequired

Describe if the beneficiary is a person or a company.

Enum"PERSON""COMPANY"
namestring[ 3 .. 511 ] charactersrequired

Complete name of the person (firstName middleName lastName) or name of the company.

friendlyNamestring[ 1 .. 255 ] characters

Friendly name given to the beneficiary.

displayboolean

Display (or not) the beneficiary to the end-user (unusable by end-user).

walletDetailsobject(WalletDetails)required
walletDetails.​addressstringrequired

Counterparty wallet address.

walletDetails.​blockchainstringrequired

Counterparty wallet blockchain. The enumeration is the same as the one in Create Wallet endpoint because you can only create transactions on the same blockchain as the wallet sender.

Enum"BITCOIN""ETHEREUM""BNB_SMART_CHAIN"
walletDetails.​typestringrequired
Enum"CUSTODIAL""NON_CUSTODIAL"
walletDetails.​providerstring

Optional, used only for CUSTODIAL wallets.

application/json
{
  "endUserId": "120e9d1f-8444-4b91-85e8-5b208615a3e5",
  "type": "PERSON",
  "name": "string",
  "friendlyName": "string",
  "display": true,
  "walletDetails": {
    "address": "string",
    "blockchain": "BITCOIN",
    "type": "CUSTODIAL",
    "provider": "string"
  }
}

Responses

Created

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

Get Information on a Crypto Beneficiary

Request

Get information on a crypto beneficiary.

Security
Linkcy-Auth
Path
cryptoBeneficiaryIdstring(uuid)required
No request payload

Responses

OK

Bodyapplication/json
idstring(uuid)required
namestringrequired
friendlyNamestring
typestringrequired
Enum"PERSON""COMPANY"
creationDatestring(date-time)required
updateDatestring(date-time)required
activebooleanrequired
displaybooleanrequired
statusstringrequired
Enum"DECLINED""PENDING_REVIEW""VALID""PENDING""NEED_ADDITIONAL_INFORMATION"
walletDetailsobject(WalletDetails_Partner)required
walletDetails.​addressstringrequired

Counterparty wallet address.

walletDetails.​blockchainstringrequired

Counterparty wallet blockchain. The enumeration is the same as the one in Create Wallet endpoint because you can only create transactions on the same blockchain as the wallet sender.

Enum"BITCOIN""ETHEREUM""BNB_SMART_CHAIN"
walletDetails.​typestringrequired
Enum"CUSTODIAL""NON_CUSTODIAL"
walletDetails.​providerstring

Optional, used only for CUSTODIAL wallets.

Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "friendlyName": "string",
  "type": "PERSON",
  "creationDate": "2019-08-24T14:15:22Z",
  "updateDate": "2019-08-24T14:15:22Z",
  "active": true,
  "display": true,
  "status": "DECLINED",
  "walletDetails": {
    "address": "string",
    "blockchain": "BITCOIN",
    "type": "CUSTODIAL",
    "provider": "string"
  }
}

Crypto Transaction

Operations

Additional

Operations

Sandbox

Operations

Web Pages

Operations