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.
You can obtain a LinkCy Authorization Key by contacting our commercial team here.
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.
{ "consumerId": "9e675a24-20d6-4913-9836-f861cd23e89e" }
{ "ttl": "PT10M" }
Id of the consumer verifying its email (Will be ignored and deducted from current authenticated user if end-user).
Subject of the verification email, by default is '[{partnerName}] Please verify your email address'.
{ "consumerId": "9e675a24-20d6-4913-9836-f861cd23e89e", "emailSubject": "[{partnerName}] Please verify your email", "urlOnSuccess": "https://google.com", "urlOnFailure": "https://google.com" }
{ "ttl": "PT48H" }
This endpoint allows you to verify an end-user's address using different methods:
LINK: This method generates a URL link that the end-user can use to complete its Proof of Address (POA).
UPLOADED_DOCUMENT: Use this method when a POA document has already been uploaded which will be used to verify the address.
DELEGATED: When the address verification is delegated to the partner (property "delegatedPoa" set to "true") and the POA document has been uploaded, you can use this method to update the address status to "VERIFIED".
{ "type": "LINK", "addressId": "785d1fc4-8ab5-48f1-8685-117cac9865d6", "ttl": "PT8H6M12.345S" }
{ "url": "string", "ttl": "PT8H6M12.345S" }