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
Operations
Operations
Operations

Request

Send a SMS to any user. For more information about allowed characters or SMS length, please refer to the twilio documentation.

Security
Linkcy-Auth
Bodyapplication/jsonrequired
Any of:
consumerIdstring(uuid)required
messagestringrequired
application/json
{ "consumerId": "9e675a24-20d6-4913-9836-f861cd23e89e", "message": "string" }

Responses

No Content

Response
No content

Request

Signing Terms & Conditions is mandatory to be able to use banking features. We mandate you as a Partner to perform this action.

To do this, you can download the last of version of the TCs directly from our APIs! By default, the language is English, but if you need a specific language, feel free to ask your customer care!

Once TCs are updated, the field "termsAccepted" will change into the "false" state and you will need to use this Endpoint to get the last version. Then, you will have to PATCH your end-users (CONSUMER/CORPORATE) each time they sign the last versions.

Query
termsAndConditionsInfoRequestDtoobject(TermsAndConditionsInfoRequestDto)required

Information used to get specific terms and conditions.

termsAndConditionsInfoRequestDto.​typestringrequired
Enum"CONSUMER""CORPORATE"
Example: "CONSUMER"
termsAndConditionsInfoRequestDto.​languagestringrequired
Default "EN"
Enum"EN""FR"
No request payload

Responses

OK

Bodyapplication/json
typestringrequired
Enum"CONSUMER""CORPORATE"
downloadUrlstringrequired

Url to download the file.

versionstringrequired
Example: "1.0"
languagestringrequired
Enum"EN""FR"
Response
application/json
{ "type": "CONSUMER", "downloadUrl": "string", "version": "1.0", "language": "EN" }

Request

Get BIC information for a given IBAN.

Security
Linkcy-Auth
Path
ibanstringrequired
No request payload

Responses

OK

Bodyapplication/json
bicstringrequired
namestring
Response
application/json
{ "bic": "string", "name": "string" }
Operations
Operations