Skip to content

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
Languages
Servers
Generated server url
https://api.sandbox.linkcy.cloud/
Operations
Operations
Operations
Operations
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
Operations
Operations
Operations

Request

This endpoint allows you to ask a KYB verification for a Corporate End-User.

In order to use this endpoint, all its UBOs and directors must have been declared and have completed a validated KYC application.

After using this endpoint, a Linkcy compliance officer will verify the information provided and update the KYB status to one of the following values:

  • VALIDATED -> this corporate is now authorized to access Linkcy's banking features.

  • NEED_ADDITIONAL_INFORMATION -> Additional information is needed to validate this corporate. The description of the requested information will be displayed in the kybStatusReason field.

  • DECLINED -> this corporate violates compliance rules and is not authorized to use Linkcy's banking features.

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

Responses

The KYB verification request was sent successfully

Response
No content

Request

Get all information of a specific share.

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

Responses

OK

Bodyapplication/json
idstring(uuid)required
ownedCorporateobject(CorporateRelatedCorporateShortInfoResponseDto)
corporateRelatedCorporateRelatedCorporateShortInfoResponseDto (object) or CorporateRelatedPhysicalShortInfoResponseDto (object)required
One of:
corporateRelated.​idstring(uuid)required
corporateRelated.​tradeNamestring
corporateRelated.​registeredNamestringrequired
directSharesPercentagenumber(float)required

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

finalSharesPercentagenumber(float)required

Percentage of the corporate end-user held.

layerinteger(int32)required

Identifier of the corporate in which he holds shares.

Response
application/json
{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "ownedCorporate": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "tradeName": "string", "registeredName": "string" }, "corporateRelated": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "tradeName": "string", "registeredName": "string" }, "directSharesPercentage": 0.1, "finalSharesPercentage": 0.1, "layer": 0 }

Request

Delete a corporate-related share.

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

Responses

No Content

Response
No content
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations