Time-to-live (TTL) duration before the link expires .
Supports ISO 8601 duration format (e.g., 'PT1800S' for 1800 seconds, 'PT5M' for 5 minutes, 'P7D' for 7 days).
Linkcy Api (1.114.5)
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.
Download OpenAPI description
Overview
Languages
Servers
Generated server url
https://api.sandbox.linkcy.cloud/
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
Request
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".
Security
Linkcy-Auth
- Generated server urlhttps://api.sandbox.linkcy.cloud/api/partner/verifications/address
- Payload
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
application/json
{ "type": "LINK", "addressId": "785d1fc4-8ab5-48f1-8685-117cac9865d6", "ttl": "PT8H6M12.345S" }
Response
application/json
{ "url": "string", "ttl": "PT8H6M12.345S" }
If you notice an error or find something unclear, we’d greatly appreciate your feedback to help us improve.
Query
Type of person. If empty, the query will return KYC applications of all people types.
Enum"CONSUMER""CORPORATE_RELATED_PHYSICAL_PERSON"
The ID of the person. If empty, the query will return everyone KYC applications.
Search KYCs by status. If empty, the query will return KYC applications with any status.
Enum"NOT_STARTED""CREATED""PROCESSING""ABORTED""PENDING_REVIEW""VALIDATED""DECLINED"
- Generated server urlhttps://api.sandbox.linkcy.cloud/api/partner/kyc
- Payload
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
No request payloadResponse
application/json
{ "content": [ { … } ], "totalElements": 1, "page": 0, "pageSize": 0 }
If you notice an error or find something unclear, we’d greatly appreciate your feedback to help us improve.
Request
Physical users need to complete a due diligence (KYC), this step is mandatory to be able to use banking features. Due diligence is performed with the local language of your users.
Once the field "phoneValidated" is in "true" state, you will be able to request a KYC for you consumer by link, SDK or if the KYC is delegated, you can directly provide us the results.
BY LINK:
The link is valid for 720H.
BY SDK:
We will provide you a SDK token valid for 24H that will allow one your user to perform its KYC via SDK. Do not hesitate to contact us for more information.
Note: We do not allow consumers to download pictures from the gallery.
Security
Linkcy-Auth
- Generated server urlhttps://api.sandbox.linkcy.cloud/api/partner/kyc
- Payload
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
application/json
{ "consumerId": "9e675a24-20d6-4913-9836-f861cd23e89e", "kycConfiguration": { "accessType": "LINK", "urlOnComplete": "https://google.com", "urlOnFailure": "https://google.com" } }
KYC successfully created
Any of:
Id and basic information of the created KYC.
The identifier of the KYC application created. When making a request with the KYC SDK: you will need to add this ID in the 'externalId' payload field (in 'metadata').
The KYC SDK JWT that you will need to use to authorize your request with the KYC SDK.
The KYC flow name you will need to use to create your request with the KYC SDK.
Response
application/json
{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "token": "string", "kycApiUrl": "string", "flowName": "string", "ttl": "PT8H6M12.345S" }