Skip to content
/
Get corporate-related ent...

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

Update a share

Request

Update information of a corporate-related share.

Security
Linkcy-Auth
Path
shareIdstring(uuid)required
Bodyapplication/jsonrequired
percentagenumber(float)required

Percentage of corporate shares held directly (same as finalSharesPercentage if direct shareholder).

application/json
{
  "percentage": 0.1
}

Responses

OK

Bodyapplication/json
idstring(uuid)required
Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

Get corporate-related entity's information

Request

Get all information about a related entity of a corporate using only it's id.

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

Responses

OK

Bodyapplication/json
Any of:

Information about this corporate-related entity.

idstring(uuid)required
externalIdstring
corporateobject(CorporateShortInfoResponseDto_Partner)required
corporate.​idstring(uuid)required
corporate.​tradeNamestring
corporate.​registeredNamestringrequired
sharesArray of objects(CorporateShareResponseDto_Partner)uniquerequired
shares[].​idstring(uuid)required
shares[].​ownedCorporateobject(CorporateShortInfoResponseDto_Partner)
shares[].​directSharesPercentagenumber(float)required

Percentage of corporate shares held directly (same as finalSharesPercentage if direct shareholder).

shares[].​finalSharesPercentagenumber(float)required

Percentage of the corporate end-user held.

shares[].​layerinteger(int32)required
addressobject(AddressResponseDto_Partner)

Address used on the bank statements of your users.

phoneobject(PhoneInfoResponseDto_Partner)
firstNamestring
middleNamestring
lastNamestring
emailobject(EmailInfoResponseDto_Partner)required
email.​addressstring
email.​verifiedbooleanrequired
email.​verificationDatestring(date-time)
genderstring
Enum"MALE""FEMALE"
birthCitystring
birthIsoCountryCodestring
Enum"ABW""AFG""AGO""AIA""ALA""ALB""AND""ARE""ARG""ARM"
birthDatestring(date)
kycInfoobject(KycInfoResponseDto_Partner)required
kycInfo.​kycApplicationIdstring(uuid)
kycInfo.​statusstringrequired
Enum"NOT_STARTED""CREATED""PROCESSING""ABORTED""PENDING_REVIEW""VALIDATED""DECLINED"
kycInfo.​statusReasonstring
kycInfo.​typestringrequired
Enum"FULL_KYC""DOC_ONLY""NOT_REQUIRED"
kycInfo.​updateDatestring(date-time)
notesstring
creationDatestring(date-time)required
updateDatestring(date-time)required
positionobject(PhysicalPersonPosition_Partner)required
position.​isAccountOwnerbooleanrequired

Indicates if this is the person who manage the corporate account.

position.​isDirectorbooleanrequired

Indicates if this entity is a director of the corporate.

position.​directorAppointmentDatestring(date)

If director, the date on which he was appointed.

position.​isUbobooleanrequired

Indicates if this person owns more than 25% of the corporate end-user shares (10% if the corporate required extended UBOs) or isSpecialUbo.

position.​isSpecialUbobooleanrequired

Indicates whether this person was designated UBO because no shareholder holds the percentage of shares required to become one.

isPepbooleanrequired

Indicates whether this person is a politically exposed person.

totalSharesPercentagenumber(float)required
nationalityCodestring
Enum"ABW""AFG""AGO""AIA""ALA""ALB""AND""ARE""ARG""ARM"
Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "externalId": "string",
  "corporate": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "tradeName": "string",
    "registeredName": "string"
  },
  "shares": [
    { … }
  ],
  "address": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "isoCountryCode": "ABW",
    "city": "string",
    "postalCode": "string",
    "street": "string",
    "number": "string",
    "refinement": "string",
    "stateOrProvince": "string",
    "status": "INVALID"
  },
  "phone": {
    "countryCode": "string",
    "number": "string",
    "verified": true,
    "verificationDate": "2019-08-24T14:15:22Z"
  },
  "firstName": "string",
  "middleName": "string",
  "lastName": "string",
  "email": {
    "address": "string",
    "verified": true,
    "verificationDate": "2019-08-24T14:15:22Z"
  },
  "gender": "MALE",
  "birthCity": "string",
  "birthIsoCountryCode": "ABW",
  "birthDate": "2019-08-24",
  "kycInfo": {
    "kycApplicationId": "79d915d9-9648-4a89-9125-d56b7a19df65",
    "status": "NOT_STARTED",
    "statusReason": "string",
    "type": "FULL_KYC",
    "updateDate": "2019-08-24T14:15:22Z"
  },
  "notes": "string",
  "creationDate": "2019-08-24T14:15:22Z",
  "updateDate": "2019-08-24T14:15:22Z",
  "position": {
    "isAccountOwner": true,
    "isDirector": true,
    "directorAppointmentDate": "2019-08-24",
    "isUbo": true,
    "isSpecialUbo": true
  },
  "isPep": true,
  "totalSharesPercentage": 0.1,
  "nationalityCode": "ABW"
}

Delete a corporate-related entity (person or corporate)

Request

Delete a corporate-related physical person or corporate whose KYB status is neither VALIDATED nor PENDING_VERIFICATION.

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

Responses

OK

Response
No content

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