Create a document request for an end-user so they can upload the required document.
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
Bodyapplication/jsonrequired
The id of the end-user, can be a consumer or corporate. Mandatory if not authenticated as end-user.
Enum"ARTICLE_OF_ASSOCIATION""BANK_ACCOUNT_DETAILS""BANK_ACCOUNT_STATEMENT""COMPANY_INCORPORATION""COMPANY_REGISTRY_EXTRACT""DIRECT_DEBIT_MANDATE""DRIVING_LICENCE""FAMILY_RECORD_BOOK""HEALTH_INSURANCE""IDENTITY_CARD"
ID of the transaction if the document is a TRANSACTION_RECEIPT or any document related to a transaction.
- Generated server urlhttps://api.sandbox.linkcy.cloud/api/partner/documents/requests
- Payload
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
application/json
{ "endUserId": "120e9d1f-8444-4b91-85e8-5b208615a3e5", "type": "ARTICLE_OF_ASSOCIATION", "note": "string", "transactionId": "75906707-8c31-479c-b354-aa805c4cefbc", "beneficiaryId": "410e5c37-9603-4e5b-81b1-7cb895f362e8", "corporateRelatedId": "f2c36984-cb53-436d-84e1-092eab51bcc5", "addressId": "785d1fc4-8ab5-48f1-8685-117cac9865d6" }
Response
application/json
{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08" }
If you notice an error or find something unclear, we’d greatly appreciate your feedback to help us improve.
- Generated server urlhttps://api.sandbox.linkcy.cloud/api/partner/documents/{documentId}
- Payload
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
No request payloadOK
Enum"ARTICLE_OF_ASSOCIATION""BANK_ACCOUNT_DETAILS""BANK_ACCOUNT_STATEMENT""COMPANY_INCORPORATION""COMPANY_REGISTRY_EXTRACT""DILIGENCE_REVIEW""DIRECT_DEBIT_MANDATE""DRIVING_LICENCE""FAMILY_RECORD_BOOK""HEALTH_INSURANCE"
ID of the transaction if the document is a TRANSACTION_RECEIPT or any document related to a transaction.
Response
application/json
{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "endUser": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08" }, "contentType": "string", "type": "ARTICLE_OF_ASSOCIATION", "friendlyName": "string", "fileName": "string", "status": "UPLOADED", "transactionId": "75906707-8c31-479c-b354-aa805c4cefbc", "beneficiaryId": "410e5c37-9603-4e5b-81b1-7cb895f362e8", "corporateRelatedId": "f2c36984-cb53-436d-84e1-092eab51bcc5", "addressId": "785d1fc4-8ab5-48f1-8685-117cac9865d6", "requested": true, "note": "string", "verificationDate": "2019-08-24T14:15:22Z", "uploadDate": "2019-08-24T14:15:22Z", "creationDate": "2019-08-24T14:15:22Z", "download": { "url": "string", "ttl": "PT8H6M12.345S" } }