Create a partner user account.
/
Get your information
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/
- Generated server urlhttps://api.sandbox.linkcy.cloud/api/partner/accounts
- Payload
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
application/json
{ "email": "string", "roles": [ "ACCOUNT_CREATE" ] }
Response
application/json
{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "otp": "string" }
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
- Payload
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
No request payloadResponse
application/json
{ "name": "string", "displayName": "string", "logoUrl": "string", "address": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "isoCountryCode": "ABW", "city": "string", "postalCode": "string", "street": "string", "number": "string", "refinement": "string", "stateOrProvince": "string", "status": "INVALID" }, "consumerOtpMessage": "string", "corporateOtpMessage": "string", "emailProperties": { "senderEmailAddress": "string", "senderEmailName": "string" }, "contactInformation": { "adminEmail": "string", "billingEmail": "string", "commercialEmail": "string", "techEmail": "string", "complianceEmail": "string" }, "limits": { "ledger": { … }, "sctInst": { … }, "limitedStatus": { … } }, "creationDate": "2019-08-24T14:15:22Z", "updateDate": "2019-08-24T14:15:22Z" }
If you notice an error or find something unclear, we’d greatly appreciate your feedback to help us improve.
Bodyapplication/jsonrequired
Address that will be used on the bank statements of your users.
Message that will be displayed when requesting a OTP message. You must include the following place holder: "$otp" where you want to display the OTP secret.
If not set, the default message is: "Your {partnerName} secret to change your password is: {secret} If you are not at the origin of this message, you can ignore it."
Message that will be displayed when requesting a OTP message. You must include the following place holder: "$otp" where you want to display the OTP secret.
If not set, the default message is: "Your {partnerName} secret to change your password is: {secret} If you are not at the origin of this message, you can ignore it."
- Generated server urlhttps://api.sandbox.linkcy.cloud/api/partner
- Payload
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
application/json
{ "address": { "isoCountryCode": "AUT", "city": "string", "postalCode": "string", "street": "string", "number": "string", "refinement": "string", "stateOrProvince": "string", "bypassVerification": true }, "consumerOtpMessage": "string", "corporateOtpMessage": "string", "displayName": "string", "logoUrl": "string", "contactInformation": { "adminEmail": "string", "billingEmail": "string", "commercialEmail": "string", "techEmail": "string", "complianceEmail": "string" } }
Response
application/json
{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "updateDate": "2019-08-24T14:15:22Z" }
If you notice an error or find something unclear, we’d greatly appreciate your feedback to help us improve.
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