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

List your corporates

Request

Fetch all your corporates. More options will be added in the near future.

Security
Linkcy-Auth
Query
sortAttributestring
Enum"UPDATE_DATE""CREATION_DATE"
registeredNamestring
kybStatusArray of strings
Items Enum"NOT_STARTED""COMPLETING""PENDING_VERIFICATION""NEED_ADDITIONAL_INFORMATION""DECLINED""VALIDATED"
bankingStatusArray of strings
Items Enum"VALIDATED""PENDING""MISSING_DATA""BLOCKED""NOT_CREATED"
suspensionStatusArray of strings
Items Enum"SUSPENDED""NOT_SUSPENDED"
linkcyStatusArray of strings
Items Enum"PENDING""FORBIDDEN""MISSING_DATA""VALIDATED""LIMITED""CLOSING""CLOSED"
complianceStatusArray of strings
Items Enum"PENDING""DECLINED""PENDING_REVIEW""VALIDATED"
overallStatusstring
Enum"ACTIVE""INACTIVE"
emailAddressstring
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(CorporateListElementDto_Partner)required
content[].​idstring(uuid)required
content[].​externalIdstring
content[].​registeredNamestringrequired
content[].​incorporationCountrystringrequired
Enum"ABW""AFG""AGO""AIA""ALA""ALB""AND""ARE""ARG""ARM"
content[].​incorporationCodestringrequired
content[].​statusobject(CorporateStatus)required
content[].​status.​bankingobject(Banking)required
content[].​status.​banking.​valuestringrequired
Enum"VALIDATED""PENDING""MISSING_DATA""BLOCKED""NOT_CREATED"
content[].​status.​banking.​reasonstring
content[].​status.​kybobject(Kyb)required
content[].​status.​kyb.​valuestringrequired
Enum"NOT_STARTED""COMPLETING""PENDING_VERIFICATION""NEED_ADDITIONAL_INFORMATION""DECLINED""VALIDATED"
content[].​status.​kyb.​reasonstring
content[].​status.​kyb.​lastVerificationRequestDatestring(date-time)
content[].​status.​suspensionobject(Suspension)required
content[].​status.​suspension.​valuestringrequired
Enum"SUSPENDED""NOT_SUSPENDED"
content[].​status.​suspension.​operatorstring
Enum"END_USER""PARTNER""LINKCY"
content[].​status.​suspension.​reasonstring
content[].​status.​linkcyobject(Linkcy)required
content[].​status.​linkcy.​valuestringrequired
Enum"PENDING""FORBIDDEN""MISSING_DATA""VALIDATED""LIMITED""CLOSING""CLOSED"
content[].​status.​linkcy.​reasonstring
content[].​status.​complianceobject(Compliance)required
content[].​status.​compliance.​valuestringrequired
Enum"PENDING""DECLINED""PENDING_REVIEW""VALIDATED"
content[].​status.​compliance.​reasonstring
content[].​status.​overallobject(Overall)required
content[].​status.​overall.​valuestringrequired
Enum"ACTIVE""INACTIVE"
content[].​creationDatestring(date-time)required
content[].​updateDatestring(date-time)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
}

Create a corporate

Request

Create a new Corporate End-User who will perform banking operations.

Security
Linkcy-Auth
Bodyapplication/jsonrequired
partnerNamestring

The partnerName, mandatory if you create a corporate as anonymous. Ignored if requesting as a partner.

externalIdstring[ 0 .. 511 ] characters

A unique identifier that you can use to link this corporate to a user in your system.

registeredNamestring[ 0 .. 255 ] charactersrequired

The official corporate name. Must only contains Latin-1 characters.

tradeNamestring[ 0 .. 255 ] characters

The name used for business if there is one. Must only contains Latin-1 characters.

incorporationCountrystringrequired

The country where the corporate has been registered in ISO3 format.

Enum"ABW""AFG""AGO""AIA""ALA""ALB""AND""ARE""ARG""ARM"
Example: "FRA"
incorporationCodestring[ 0 .. 255 ] charactersrequired

The official incorporation code assigned in the country. Must only contains Latin-1 characters.

Example: "12345678900013"
incorporationDatestring(date)

The date the corporate was officially registered.

legalTypeAustriaLegalType (object) or BelgiumLegalType (object) or BulgariaLegalType (object) or SwitzerlandLegalType (object) or CyprusLegalType (object) or CzechiaLegalType (object) or GermanyLegalType (object) or DenmarkLegalType (object) or EstoniaLegalType (object) or SpainLegalType (object) or FinlandLegalType (object) or FranceLegalType (object) or MonacoLegalType (object) or UnitedKingdomLegalType (object) or GreeceLegalType (object) or CroatiaLegalType (object) or HungaryLegalType (object) or IrelandLegalType (object) or IcelandLegalType (object) or ItalyLegalType (object) or LiechtensteinLegalType (object) or LithuaniaLegalType (object) or LuxembourgLegalType (object) or LatviaLegalType (object) or MaltaLegalType (object) or NetherlandsLegalType (object) or NorwayLegalType (object) or PolandLegalType (object) or PortugalLegalType (object) or RomaniaLegalType (object) or SwedenLegalType (object) or SloveniaLegalType (object) or SlovakiaLegalType (object)(CorporateApiLegalType)
Any of:
websitestring[ 0 .. 511 ] characters
industrystringrequired
Enum"ADULT_ENTERTAINMENT""DATING_SERVICES""ESCORT_SERVICES""HOLDING_OR_TRADING_CO_FOR_ASSET_MANAGEMENT_PURPOSES""USED_CAR_RESALE_AND_DISTRIBUTION""AVIATION_COMMERCIAL_CHARTERS_AND_AIRLINES""FOOD_RESTAURANT_CATERING""CHARITY_NON_RECOGNIZED""CHARITY_RECOGNIZED""TRANSPORT_TAXI_SERVICES_CHAUFFEUR"
vatNumberstring

The corporate VAT number.

registeredAddressobject(EuropeanAddressRequest)required
registeredAddress.​isoCountryCodestring(European Country Code)required
Enum"AUT""AND""BEL""BGR""CHE""CYP""CZE""DEU""DNK""ESP"
registeredAddress.​citystring[ 0 .. 255 ] charactersrequired
registeredAddress.​postalCodestring[ 0 .. 10 ] charactersrequired
registeredAddress.​streetstring[ 0 .. 511 ] charactersrequired
registeredAddress.​numberstring[ 0 .. 255 ] characters
registeredAddress.​refinementstring[ 0 .. 35 ] characters
registeredAddress.​stateOrProvincestring[ 0 .. 255 ] characters
registeredAddress.​bypassVerificationboolean

If true, the address will be saved as described in the request without any auto-verification and the status will be INVALID until a POA is provided.

By default is false.

businessAddressobject(EuropeanAddressRequest)
financialInformationRequestDtoobject(FinancialInformation)
employeesRangestring

Range of the number of employees working for the corporate.

Enum"BTW_1_AND_10""BTW_11_AND_50""MORE_THAN_50"
accountPurposesArray of stringsunique
Items Enum"PAY_BILLS""MONEY_TO_FROM_FAMILY""DIVIDENDS""SAVINGS""PERSONAL_BUSINESS_PURPOSES""PENSION""CRYPTO""SALARY""LOTTERY_GAMING""RECONCILIATION"
lastTermsAcceptedstring

The version of the terms and conditions signed by the corporate account owner.

Example: "1.0"
accountOwnerInfoobject(AccountOwnerInfo)required

Information of the person who will manage this corporate end-user account.

accountOwnerInfo.​firstNamestring[ 0 .. 255 ] charactersrequired
accountOwnerInfo.​lastNamestring[ 0 .. 255 ] charactersrequired
accountOwnerInfo.​isDirectorbooleanrequired

Indicates if the owner is also a director.

accountOwnerInfo.​directorAppointmentDatestring(date)

If director, the date on which he was appointed.

accountOwnerInfo.​directSharesPercentagenumber(float)[ 0 .. 100 ]
accountOwnerInfo.​addressobject(WorldwideAddressRequest)
accountOwnerInfo.​nationalityCodestring
Enum"ABW""AFG""AGO""AIA""ALA""ALB""AND""ARE""ARG""ARM"
accountOwnerInfo.​emailAddressstring
accountOwnerInfo.​phoneobject(PhoneRequestDto)required
accountOwnerInfo.​phone.​countryCodestringrequired
Example: "33"
accountOwnerInfo.​phone.​numberstring^[0-9]{1,14}$required
metadataobject(JsonNode)

A custom field to save data.

This field's size is limited to 3000 characters.

application/json
{
  "partnerName": "string",
  "externalId": "string",
  "registeredName": "string",
  "tradeName": "string",
  "incorporationCountry": "FRA",
  "incorporationCode": "12345678900013",
  "incorporationDate": "2019-08-24",
  "legalType": {
    "austriaValue": "AT_AKTIENGESELLSCHAFT_AG"
  },
  "website": "string",
  "industry": "ADULT_ENTERTAINMENT",
  "vatNumber": "string",
  "registeredAddress": {
    "isoCountryCode": "AUT",
    "city": "string",
    "postalCode": "string",
    "street": "string",
    "number": "string",
    "refinement": "string",
    "stateOrProvince": "string",
    "bypassVerification": true
  },
  "businessAddress": {
    "isoCountryCode": "AUT",
    "city": "string",
    "postalCode": "string",
    "street": "string",
    "number": "string",
    "refinement": "string",
    "stateOrProvince": "string",
    "bypassVerification": true
  },
  "financialInformationRequestDto": {
    "currency": "EUR",
    "monthlyNetIncome": "LESS_THAN_10_000",
    "expectedMonthlyIncomingVolume": "LESS_THAN_10_000",
    "expectedMonthlyOutgoingVolume": "LESS_THAN_10_000",
    "expectedMonthlyIncomingTransferFrequency": "LESS_THAN_TWO_TIMES"
  },
  "employeesRange": "BTW_1_AND_10",
  "accountPurposes": [
    "PAY_BILLS"
  ],
  "lastTermsAccepted": "1.0",
  "accountOwnerInfo": {
    "firstName": "string",
    "lastName": "string",
    "isDirector": true,
    "directorAppointmentDate": "2019-08-24",
    "directSharesPercentage": 100,
    "address": { … },
    "nationalityCode": "ABW",
    "emailAddress": "string",
    "phone": { … }
  },
  "metadata": {}
}

Responses

Created

Bodyapplication/json
corporateIdstring(uuid)required

The new corporate identifier.

accountOwnerIdstring(uuid)required

The account owner identifier.

Response
application/json
{
  "corporateId": "50eb73c4-9d2f-4e30-9f0c-2d57c30a46ee",
  "accountOwnerId": "41bfc29a-63f5-4057-9938-10cfd5e1771b"
}

Get corporate's information

Request

Get all information about a corporate using only its corporate ID.

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

Responses

OK

Bodyapplication/json
idstring(uuid)required
externalIdstring
registeredNamestringrequired
tradeNamestring
incorporationCountrystringrequired
Enum"ABW""AFG""AGO""AIA""ALA""ALB""AND""ARE""ARG""ARM"
incorporationCodestringrequired
incorporationDatestring(date)
legalTypestring
Enum"AL_SHOQERI_AKSIONERE_SHA""AL_SHOQERI_KOLEKTIVE""AL_SHOQERI_KOMANDITE""AL_SHOQERI_ME_PERGJEGJESI_TE_KUFIZUAR_SHPK""AR_SOCIEDAD_ANONIMA_SA""AR_SOCIEDAD_COLECTIVA_SOCCOL""AR_SOCIEDAD_DEL_ESTADO_SE""AR_SOCIEDAD_DE_CAPITAL_E_INDUSTRIA_SCEI""AR_SOCIEDAD_DE_GARANTIA_RECIPROCA_SGR""AR_SOCIEDAD_DE_RESPONSABILIDAD_LIMITADA_SRL"
websitestring
industrystringrequired
Enum"ADULT_ENTERTAINMENT""DATING_SERVICES""ESCORT_SERVICES""HOLDING_OR_TRADING_CO_FOR_ASSET_MANAGEMENT_PURPOSES""USED_CAR_RESALE_AND_DISTRIBUTION""AVIATION_COMMERCIAL_CHARTERS_AND_AIRLINES""FOOD_RESTAURANT_CATERING""CHARITY_NON_RECOGNIZED""CHARITY_RECOGNIZED""TRANSPORT_TAXI_SERVICES_CHAUFFEUR"
vatNumberstring
registeredAddressobject(AddressResponseDto_Partner)required

Address used on the bank statements of your users.

registeredAddress.​idstring(uuid)required
registeredAddress.​isoCountryCodestringrequired
Enum"ABW""AFG""AGO""AIA""ALA""ALB""AND""ARE""ARG""ARM"
registeredAddress.​citystringrequired
registeredAddress.​postalCodestring
registeredAddress.​streetstring
registeredAddress.​numberstring
registeredAddress.​refinementstring
registeredAddress.​stateOrProvincestring
registeredAddress.​statusstringrequired
Enum"INVALID""VALID""PENDING""VERIFIED""ARCHIVED""DECLINED"
businessAddressobject(AddressResponseDto_Partner)

Address used on the bank statements of your users.

employeesRangestring
Enum"BTW_1_AND_10""BTW_11_AND_50""MORE_THAN_50"
financialInformationobject(FinancialInformation)
accountPurposesArray of stringsuniquerequired
Items Enum"PAY_BILLS""MONEY_TO_FROM_FAMILY""DIVIDENDS""SAVINGS""PERSONAL_BUSINESS_PURPOSES""PENSION""CRYPTO""SALARY""LOTTERY_GAMING""RECONCILIATION"
complianceInfoobject(ComplianceInfo_Partner)required
complianceInfo.​maxUbosLayerinteger(int32)required
complianceInfo.​relatedLayersTotalinteger(int32)required
complianceInfo.​isExtendedUbosbooleanrequired
termsAcceptedbooleanrequired
strongAuthenticationobject(ScaDeviceInfo)required
strongAuthentication.​idstring(uuid)required
strongAuthentication.​endpointIdstringrequired
strongAuthentication.​creationDatestring(date-time)required
strongAuthentication.​pinStatusstringrequired
Value"SET"
strongAuthentication.​biometryStatusstringrequired
Value"SET"
scaDevicesArray of objects(ScaDeviceInfoDto_Partner)uniquerequired
scaDevices[].​idstring(uuid)required
scaDevices[].​statusstringrequired
Enum"CREATED""AWAITING_ACTIVATION""ACTIVE""SUSPENDED""REMOVED"
scaDevices[].​creationDatestring(date-time)required
scaDevices[].​namestring
scaDevices[].​platformstring
scaDevices[].​deviceInfostring
notesstring

Public additional information concerning this entity.

creationDatestring(date-time)required
updateDatestring(date-time)required
statusobject(CorporateStatus)required
status.​bankingobject(Banking)required
status.​banking.​valuestringrequired
Enum"VALIDATED""PENDING""MISSING_DATA""BLOCKED""NOT_CREATED"
status.​banking.​reasonstring
status.​kybobject(Kyb)required
status.​kyb.​valuestringrequired
Enum"NOT_STARTED""COMPLETING""PENDING_VERIFICATION""NEED_ADDITIONAL_INFORMATION""DECLINED""VALIDATED"
status.​kyb.​reasonstring
status.​kyb.​lastVerificationRequestDatestring(date-time)
status.​suspensionobject(Suspension)required
status.​suspension.​valuestringrequired
Enum"SUSPENDED""NOT_SUSPENDED"
status.​suspension.​operatorstring
Enum"END_USER""PARTNER""LINKCY"
status.​suspension.​reasonstring
status.​linkcyobject(Linkcy)required
status.​linkcy.​valuestringrequired
Enum"PENDING""FORBIDDEN""MISSING_DATA""VALIDATED""LIMITED""CLOSING""CLOSED"
status.​linkcy.​reasonstring
status.​complianceobject(Compliance)required
status.​compliance.​valuestringrequired
Enum"PENDING""DECLINED""PENDING_REVIEW""VALIDATED"
status.​compliance.​reasonstring
status.​overallobject(Overall)required
status.​overall.​valuestringrequired
Enum"ACTIVE""INACTIVE"
partnerMetadataobject(Metadata)
userMetadataobject(Metadata)
Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "externalId": "string",
  "registeredName": "string",
  "tradeName": "string",
  "incorporationCountry": "ABW",
  "incorporationCode": "string",
  "incorporationDate": "2019-08-24",
  "legalType": "AL_SHOQERI_AKSIONERE_SHA",
  "website": "string",
  "industry": "ADULT_ENTERTAINMENT",
  "vatNumber": "string",
  "registeredAddress": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "isoCountryCode": "ABW",
    "city": "string",
    "postalCode": "string",
    "street": "string",
    "number": "string",
    "refinement": "string",
    "stateOrProvince": "string",
    "status": "INVALID"
  },
  "businessAddress": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "isoCountryCode": "ABW",
    "city": "string",
    "postalCode": "string",
    "street": "string",
    "number": "string",
    "refinement": "string",
    "stateOrProvince": "string",
    "status": "INVALID"
  },
  "employeesRange": "BTW_1_AND_10",
  "financialInformation": {
    "expectedMonthlyOutgoingVolume": "LESS_THAN_10_000",
    "currency": "EUR",
    "monthlyNetIncome": "LESS_THAN_10_000",
    "expectedMonthlyIncomingVolume": "LESS_THAN_10_000",
    "expectedMonthlyIncomingTransferFrequency": "LESS_THAN_TWO_TIMES"
  },
  "accountPurposes": [
    "PAY_BILLS"
  ],
  "complianceInfo": {
    "maxUbosLayer": 0,
    "relatedLayersTotal": 0,
    "isExtendedUbos": true
  },
  "termsAccepted": true,
  "strongAuthentication": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "endpointId": "string",
    "creationDate": "2019-08-24T14:15:22Z",
    "pinStatus": "SET",
    "biometryStatus": "SET"
  },
  "scaDevices": [
    { … }
  ],
  "notes": "string",
  "creationDate": "2019-08-24T14:15:22Z",
  "updateDate": "2019-08-24T14:15:22Z",
  "status": {
    "banking": { … },
    "kyb": { … },
    "suspension": { … },
    "linkcy": { … },
    "compliance": { … },
    "overall": { … }
  },
  "partnerMetadata": {},
  "userMetadata": {}
}

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

Web Pages

Operations