Skip to content

Overview

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.

Authentication

You can obtain a LinkCy Authorization Key by contacting our commercial team here.

Download OpenAPI description
Languages
Servers
Generated server url
https://api.sandbox.linkcy.cloud/
Operations
Operations
Operations
Operations
Operations

Request

Suspend an end-user and all associated cards.

Card will show a new rule with type LINKCY setting the transaction limit to 0.

Security
Linkcy-Auth
Path
endUserIdstring(uuid)required
Bodyapplication/jsonrequired
operatorstring(Operator)
Enum"END_USER""PARTNER""LINKCY"
reasonstringrequired
application/json
{ "operator": "END_USER", "reason": "string" }

Responses

No Content

Response
No content

Request

Retrieve the list of addresses associated with an end-user using its ID.

Security
Linkcy-Auth
Path
endUserIdstring(uuid)required
Query
addressStatusstring
Enum"INVALID""VALID""PENDING""VERIFIED""ARCHIVED""DECLINED"
isPrincipalboolean
No request payload

Responses

OK

Bodyapplication/jsonArray [
idstring(uuid)required
isoCountryCodestringrequired
Enum"ABW""AFG""AGO""AIA""ALA""ALB""AND""ARE""ARG""ARM"
citystringrequired
postalCodestring
streetstring
numberstring
refinementstring
stateOrProvincestring
statusstringrequired
Enum"INVALID""VALID""PENDING""VERIFIED""ARCHIVED""DECLINED"
]
Response
application/json
[ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "isoCountryCode": "ABW", "city": "string", "postalCode": "string", "street": "string", "number": "string", "refinement": "string", "stateOrProvince": "string", "status": "INVALID" } ]

Request

Unsuspend an end-user, this operation will also delete the card rules that were created by this suspension.

Security
Linkcy-Auth
Path
endUserIdstring(uuid)required
operatorstring(Operator)required
Enum"END_USER""PARTNER""LINKCY"
No request payload

Responses

No Content

Response
No content

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
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations