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

Get diligence review of a corporate

Request

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

Responses

OK

Bodyapplication/json
urlstringrequired
ttlstringrequired
Example: "PT8H6M12.345S"
Response
application/json
{ "url": "string", "ttl": "PT8H6M12.345S" }

Get corporate-related entities list

Request

Get access to the information of all related entities of a corporate.

Security
Linkcy-Auth
Query
sortAttributestring
Enum"UPDATE_DATE""CREATION_DATE"
ownedCorporateRelatedIdstring(uuid)

Parameter to get only the shareholders of this specified corporate-related corporate.

layerinteger(int32)

Parameter allowing to obtain the associated entities on a specific layer of the corporate.

corporateIdstring(uuid)
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 CorporateRelatedPhysicalPersonListElement_Partner (object) or CorporateRelatedCorporateListElement_Partner (object)(CorporateRelatedListElementDto_Partner)required
Any of:
content[].​idstring(uuid)required
content[].​externalIdstring
content[].​firstNamestring
content[].​lastNamestring
content[].​addressobject(AddressResponseDto_Partner)

Address used on the bank statements of your users.

content[].​nationalityCodestring
Enum"ABW""AFG""AGO""AIA""ALA""ALB""AND""ARE""ARG""ARM"
content[].​phoneobject(PhoneInfoResponseDto_Partner)
content[].​emailAddressstring
content[].​kycInfoobject(KycInfoResponseDto_Partner)required
content[].​kycInfo.​kycApplicationIdstring(uuid)
content[].​kycInfo.​statusstringrequired
Enum"NOT_STARTED""CREATED""PROCESSING""ABORTED""PENDING_REVIEW""VALIDATED""DECLINED"
content[].​kycInfo.​statusReasonstring
content[].​kycInfo.​typestringrequired
Enum"FULL_KYC""DOC_ONLY""NOT_REQUIRED"
content[].​kycInfo.​updateDatestring(date-time)
content[].​positionobjectrequired
content[].​position.​isAccountOwnerbooleanrequired

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

content[].​position.​isDirectorbooleanrequired

Indicates if this entity is a director of the corporate.

content[].​position.​directorAppointmentDatestring(date)

If director, the date on which he was appointed.

content[].​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.

content[].​position.​isSpecialUbobooleanrequired

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

content[].​updateDatestring(date-time)required
content[].​creationDatestring(date-time)required
content[].​totalSharePercentagenumber(float)required
content[].​corporateobjectrequired
content[].​corporate.​idstring(uuid)required
content[].​corporate.​tradeNamestring
content[].​corporate.​registeredNamestringrequired
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 }
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations