Skip to content
/
Update a corporate

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

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": {}
}

Update a corporate

Request

You can patch a corporate to update some information. Once the KYB status is VALIDATED or DECLINED, you will not be able to patch new information except to change the account owner or the external identifier.

Security
Linkcy-Auth
Path
corporateIdstring(uuid)required
Bodyapplication/jsonrequired
externalIdstring[ 0 .. 511 ] characters

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

registeredNamestring[ 0 .. 255 ] characters

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.

incorporationCountrystring

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 ] characters

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_Partner (object) or BelgiumLegalType_Partner (object) or BulgariaLegalType_Partner (object) or SwitzerlandLegalType_Partner (object) or CyprusLegalType_Partner (object) or CzechiaLegalType_Partner (object) or GermanyLegalType_Partner (object) or DenmarkLegalType_Partner (object) or EstoniaLegalType_Partner (object) or SpainLegalType_Partner (object) or FinlandLegalType_Partner (object) or FranceLegalType_Partner (object) or MonacoLegalType_Partner (object) or UnitedKingdomLegalType_Partner (object) or GreeceLegalType_Partner (object) or CroatiaLegalType_Partner (object) or HungaryLegalType_Partner (object) or IrelandLegalType_Partner (object) or IcelandLegalType_Partner (object) or ItalyLegalType_Partner (object) or LiechtensteinLegalType_Partner (object) or LithuaniaLegalType_Partner (object) or LuxembourgLegalType_Partner (object) or LatviaLegalType_Partner (object) or MaltaLegalType_Partner (object) or NetherlandsLegalType_Partner (object) or NorwayLegalType_Partner (object) or PolandLegalType_Partner (object) or PortugalLegalType_Partner (object) or RomaniaLegalType_Partner (object) or SwedenLegalType_Partner (object) or SloveniaLegalType_Partner (object) or SlovakiaLegalType_Partner (object)(CorporateApiLegalType_Partner)
Any of:
websitestring[ 0 .. 511 ] characters
industrystring
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)

Address that will be used on the bank statements of your users.

businessAddressobject(EuropeanAddressRequest)

Address that will be used on the bank statements of your users.

financialInformationRequestDtoobject(FinancialInformation)
employeesRangestring

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"
userMetadataobject(User metadata)

A custom field to save data.

This field's size is limited to 3000 characters.

partnerMetadataobject(Partner metadata)

A custom field to save data that cannot be modified by the end-user.

This field's size is limited to 3000 characters.

Note: if you are authenticated as end-user, trying to update this field will result in a Forbidden Error.

application/json
{
  "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",
  "userMetadata": {
    "property1": {},
    "property2": {}
  },
  "partnerMetadata": {
    "property1": {},
    "property2": {}
  }
}

Responses

OK

Bodyapplication/json
idstring(uuid)required

Identifier of the updated corporate.

updateDatestring(date-time)required
Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "updateDate": "2019-08-24T14:15:22Z"
}

Get corporate's information given its external id

Request

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

Security
Linkcy-Auth
Path
externalIdstringrequired
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