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

Crypto Transaction

Operations

Additional

Operations

Sandbox

Operations

Simulate a transaction

Request

Allows you to simulate a transaction of a specific type, useful for generating data in sandbox environment and therefore use transaction payloads before going into production.

  • Card Authorization : Simulates a transaction authorization on the given card.
  • Card Clearing : Simulates the clearing of the previous authorization using its transaction id.
  • Credit Ledger : Simulates a transaction to the given ledger. The amount can contain 2 decimal places and the maximum is 1000.
Security
Linkcy-Auth
Bodyapplication/jsonrequired
Any of:
amountnumberrequired
cardIdstring(uuid)required
merchantNamestring
merchantCitystring
merchantCountrystring
merchantIdstring
merchantCategoryCodestring
application/json
{
  "amount": 0,
  "cardId": "f16ba382-eb42-481a-b08f-c57bdc9aae24",
  "merchantName": "string",
  "merchantCity": "string",
  "merchantCountry": "string",
  "merchantId": "string",
  "merchantCategoryCode": "string"
}

Responses

OK

Response
No content

Initialize or reset a password with secret in response

Request

Whether you want to initialize first password or reset a password, you should use this endpoint. Send a secret in response that can be used to change the password of the account.

Security
Linkcy-Auth
Bodyapplication/jsonrequired
Any of:
consumerPhonestring^[0-9]{2,17}$required

The complete consumer's phone, including country code. Must not contain +.

Example: "33123456789"
partnerNamestringrequired
application/json
{
  "consumerPhone": "33123456789",
  "partnerName": "string"
}

Responses

OK

Bodyapplication/json
passwordChangeSecretstringrequired
Response
application/json
{
  "passwordChangeSecret": "string"
}

Simulate a KYC result for a consumer or a corporate-related person

Request

Simulate a KYC for a consumer or corporate related person with custom values.

The missing information will be automatically populated with default values.

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

Id of the consumer doing the KYC (Will be ignored and deducted from current authenticated user if consumer)

kycStatusstringrequired

The new KYC status

Enum"NOT_STARTED""CREATED""PROCESSING""PENDING_REVIEW""ABORTED""VALIDATED""DECLINED"
addressobject(EuropeanAddressRequest)
firstNamestring[ 0 .. 255 ] characters
middleNamestring[ 0 .. 255 ] characters
lastNamestring[ 0 .. 255 ] characters
genderstring
Enum"MALE""FEMALE"
birthDatestring(date)
emailAddressstring
birthCitystring
birthIsoCountryCodestring
Enum"ABW""AFG""AGO""AIA""ALA""ALB""AND""ARE""ARG""ARM"
nationalityCodestring
Enum"ABW""AFG""AGO""AIA""ALA""ALB""AND""ARE""ARG""ARM"
onboardingIpAddressstring
application/json
{
  "consumerId": "9e675a24-20d6-4913-9836-f861cd23e89e",
  "kycStatus": "NOT_STARTED",
  "address": {
    "isoCountryCode": "AUT",
    "city": "string",
    "postalCode": "string",
    "street": "string",
    "number": "string",
    "refinement": "string",
    "stateOrProvince": "string",
    "bypassVerification": true
  },
  "firstName": "string",
  "middleName": "string",
  "lastName": "string",
  "gender": "MALE",
  "birthDate": "2019-08-24",
  "emailAddress": "string",
  "birthCity": "string",
  "birthIsoCountryCode": "ABW",
  "nationalityCode": "ABW",
  "onboardingIpAddress": "string"
}

Responses

Simulated KYC successfully created

Bodyapplication/json
Any of:
kycApplicationIdstring(uuid)required
consumerIdstring(uuid)required

Id of the consumer doing the KYC

Response
application/json
{
  "kycApplicationId": "79d915d9-9648-4a89-9125-d56b7a19df65",
  "consumerId": "9e675a24-20d6-4913-9836-f861cd23e89e"
}

Web Pages

Operations