Get all information about a related entity of a corporate using only it's id.
- Delete a corporate-related entity (person or corporate)
Create a share
Declare a corporate-related entity (person or corporate)
Ask a KYB verification
Get share's information
Delete a share
Update a share
Get corporate-related entity's information
Update a corporate-related entity (person or corporate)
Get diligence review of a corporate
Get corporate-related entities list
Delete a corporate-relate...
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
- Generated server urlhttps://api.sandbox.linkcy.cloud/api/partner/corporates/related/{corporateRelatedId}
- Payload
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
No request payloadOK
Any of:
Information about this corporate-related entity.
Percentage of corporate shares held directly (same as finalSharesPercentage if direct shareholder).
Indicates if this is the person who manage the corporate account.
Indicates if this person owns more than 25% of the corporate end-user shares (10% if the corporate required extended UBOs) or isSpecialUbo.
Response
application/json
{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "externalId": "string", "corporate": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "tradeName": "string", "registeredName": "string" }, "shares": [ { … } ], "address": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "isoCountryCode": "ABW", "city": "string", "postalCode": "string", "street": "string", "number": "string", "refinement": "string", "stateOrProvince": "string", "status": "INVALID" }, "phone": { "countryCode": "string", "number": "string", "verified": true, "verificationDate": "2019-08-24T14:15:22Z" }, "firstName": "string", "middleName": "string", "lastName": "string", "email": { "address": "string", "verified": true, "verificationDate": "2019-08-24T14:15:22Z" }, "gender": "MALE", "birthCity": "string", "birthIsoCountryCode": "ABW", "birthDate": "2019-08-24", "kycInfo": { "kycApplicationId": "79d915d9-9648-4a89-9125-d56b7a19df65", "status": "NOT_STARTED", "statusReason": "string", "type": "FULL_KYC", "updateDate": "2019-08-24T14:15:22Z" }, "notes": "string", "creationDate": "2019-08-24T14:15:22Z", "updateDate": "2019-08-24T14:15:22Z", "position": { "isAccountOwner": true, "isDirector": true, "directorAppointmentDate": "2019-08-24", "isUbo": true, "isSpecialUbo": true }, "isPep": true, "totalSharesPercentage": 0.1, "nationalityCode": "ABW" }
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/corporates/related/{corporateRelatedId}
- Payload
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
No request payloadIf you notice an error or find something unclear, we’d greatly appreciate your feedback to help us improve.
Request
You can patch a corporate related to update some information whether it's a corporate or a person. Depending on the information patched, you will have to perform another action:
- As a person:
First name -> no actions to perform
Last name -> no actions to perform
Phone -> you will need to use Endpoint POST Send consumer verification code & validate consumer phone
Address : we will use our tools to check if the address is valid or not, we recommend you to ask your consumer to confirm the address once the modification is done. Address is very important to send cards. Once the card is activated, the address status will go from valid to verified.
Email address -> The "emailAddressVerified" status will switch to "false" you will need to use Endpoint POST Send a verification email to the consumer to verify the email address.
- As a corporate:
Registered name -> no actions to perform
Incorporation code -> no actions to perform
Incorporation country -> no actions to perform
Security
Linkcy-Auth
Any of:
The information to update a corporate related.
A unique identifier that you can use to link this corporate related to a user in your system.
Update the phone of this corporate related person. Note: if you wish to change the phone of an account owner, please contact us.
- Generated server urlhttps://api.sandbox.linkcy.cloud/api/partner/corporates/related/{corporateRelatedId}
- Payload
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
application/json
{ "externalId": "string", "isDirector": true, "directorAppointmentDate": "2019-08-24", "firstName": "string", "middleName": "string", "lastName": "string", "address": { "isoCountryCode": "ABW", "city": "string", "postalCode": "string", "street": "string", "number": "string", "refinement": "string", "stateOrProvince": "string", "bypassVerification": true }, "nationalityCode": "ABW", "emailAddress": "string", "phone": { "countryCode": "33", "number": "string" }, "isSpecialUbo": true }
Response
application/json
{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08" }