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

Create a new corporate-related share.

Security
Linkcy-Auth
Bodyapplication/jsonrequired
Any of:

Must be filled in if the owner is UBO (shareholder with 25%+ shares or 10%+ shares if the corporate must provide extended UBOs).

corporateRelatedIdstring(uuid)required
percentagenumber(float)[ 0 .. 100 ]required

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

application/json
{ "corporateRelatedId": "f2c36984-cb53-436d-84e1-092eab51bcc5", "percentage": 100 }

Responses

Created

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

Declare a corporate-related entity (person or corporate)

Request

Add a person or corporate-related to the current corporate who may be the account owner, a director or a UBO (shareholder with 25%+ shares (10% if the corporate required extended UBOs)).

Adding all the directors and UBOs of the corporate is a mandatory step to complete the KYB and access all banking features.

After adding a corporate-related person, you must provide them with a KYC link.

Security
Linkcy-Auth
Path
corporateIdstring(uuid)required
Bodyapplication/jsonrequired
isDirectorbooleanrequired

Indicates if this entity is a director of the corporate.

directorAppointmentDatestring(date)

If director, the date on which he was appointed.

sharesInfoArray of Direct Share (object) or Indirect Share (object)(ShareDataDto)uniquerequired
Any of:

Must be filled in if the owner is UBO (shareholder with 25%+ shares or 10%+ shares if the corporate must provide extended UBOs).

sharesInfo[].​percentagenumber(float)[ 0 .. 100 ]required

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

infoCorporateRelatedPhysicalPersonInfoDto (object) or CorporateRelatedCorporateInfoDto (object)(CorporateRelatedInfoDto)required

Information about this corporate-related entity.

Any of:

Information about this corporate-related entity.

info.​firstNamestring[ 0 .. 255 ] charactersrequired
info.​lastNamestring[ 0 .. 255 ] charactersrequired
info.​addressobject(WorldwideAddressRequest)
info.​nationalityCodestring
Enum"ABW""AFG""AGO""AIA""ALA""ALB""AND""ARE""ARG""ARM"
info.​emailAddressstring
info.​phoneobject(PhoneRequestDto)
info.​isSpecialUboboolean

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

application/json
{ "isDirector": true, "directorAppointmentDate": "2019-08-24", "sharesInfo": [ {} ], "info": { "firstName": "string", "lastName": "string", "address": {}, "nationalityCode": "ABW", "emailAddress": "string", "phone": {}, "isSpecialUbo": true } }

Responses

Created

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

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
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations