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

Verify phone verification code

Request

This second step allow LinkCy to verify that the phone number and country code provided by the consumer is valid and he controls the SIM.

If the consumer does not provide a valid code, he will not get access to the KYC step which is also mandatory.

The SMS code is a 6-digits and valid for 10 minutes and the consumer has 5 attempts. Once the delay of the number of attempts is reached, you have to ask for another code by using: Send consumer verification code Endpoint here.

Note: You can simulate that step in a Sandbox environment. Code is always 123456.

Security
Linkcy-Auth
Bodyapplication/jsonrequired
Any of:
consumerIdstring(uuid)

The id of the verified consumer.

Mandatory if not authenticated as consumer.

codestring^[0-9]{6}$required

The code received by the consumer.

In play environment code is always 123456.

application/json
{
  "consumerId": "9e675a24-20d6-4913-9836-f861cd23e89e",
  "code": "string"
}

Responses

Phone was successfully verified

Response
No content

Send phone verification code by sms

Request

This Endpoint allows you to send a verification code to your user by SMS. This code is a 6-digit code.

If you want to personalize the Sender Name, please contact your customer care.

NOTE : In Sandbox, no SMS is sent. Verification code will always be 123456

Security
Linkcy-Auth
Bodyapplication/jsonrequired
Any of:
consumerIdstring(uuid)

Id of the consumer verifying.

Mandatory if not authenticated as consumer.

application/json
{
  "consumerId": "9e675a24-20d6-4913-9836-f861cd23e89e"
}

Responses

Message sent

Bodyapplication/json
ttlstringrequired

The phone verification code time to live duration in ISO 8601.

Default "PT10M"
Response
application/json
{
  "ttl": "PT10M"
}

Send an email verification link by email

Request

This Endpoint allows you to send an email verification to your user. The user will receive a link by email in order to verify his current email.

Security
Linkcy-Auth
Bodyapplication/jsonrequired
Any of:
consumerIdstring(uuid)

Id of the consumer verifying its email (Will be ignored and deducted from current authenticated user if end-user).

emailSubjectstring[ 0 .. 255 ] characters

Subject of the verification email, by default is '[{partnerName}] Please verify your email address'.

Example: "[{partnerName}] Please verify your email"
urlOnSuccessstring

Redirect url on email verified.

Example: "https://google.com"
urlOnFailurestring

Redirect url on email verification failed.

Example: "https://google.com"
application/json
{
  "consumerId": "9e675a24-20d6-4913-9836-f861cd23e89e",
  "emailSubject": "[{partnerName}] Please verify your email",
  "urlOnSuccess": "https://google.com",
  "urlOnFailure": "https://google.com"
}

Responses

Verification email sent

Bodyapplication/json
ttlstringrequired

The email verification link time to live duration in ISO 8601.

Default "PT48H"
Response
application/json
{
  "ttl": "PT48H"
}

KYB

Operations

Documents

Operations

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