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

Request

Activate the previously registered device in order to finalise the registration.

Security
Linkcy-Auth
Path
scaDeviceIdstring(uuid)required
No request payload

Responses

SCA device is being activated

Response
No content

Request

Register a device for an end user as a second factor to enable Strong Customer Authentication (SCA).

This operation might require SCA.

Security
Linkcy-Auth
Path
endUserIdstring(uuid)required
Headers
Linkcy-SCA-Strategystring

The strategy to use when a SCA is required:

More information:
  • PUSH_NOTIFICATION: will send a notification if the SCA is required.
  • DATA_SIGNING: Linkcy-SCA-Signature header must contain signature provided by PowerAuth Mobile SDK on registered device.
  • BY_PASS: Sandbox only - will ignore any SCA if used.
Error Codes
  • 409 Conflict
    • SCA_REQUIRED: The operation you are trying to do requires SCA, current strategy {0}.
Default PUSH_NOTIFICATION
Enum"PUSH_NOTIFICATION""DATA_SIGNING""BY_PASS"
Linkcy-SCA-Signaturestring

The signature that needs to be validated, it is generated from data signing.

More information:
  • Signature will be verified against wultra.
  • Operation will be denied if signature is not valide.
  • Avoid creating multiple signature at same time for the same registration.
  • Signature TTL is 30 sec.
Error Codes
  • 401 Forbidden
    • SCA_SIGNATURE_DOES_NOT_MATCH: The sca signature provided doesn't match the one required for this operation
  • 404 Not Found
    • NO_ACTIVE_SCA_DEVICE_FOUND: No active SCA device could be found.
  • 409 Conflict
    • SCA_DEVICE_NOT_VALID: The device cannot be used to sign this data.
    • SCA_SIGNATURE_FORMAT_INVALID: The signature format for data signing SCA strategy is invalid: HTTP header validation failed.
    • SCA_SIGNATURE_MISSING: The signature required for data signing SCA strategy is missing.
  • 500 Internal Server Error
    • SCA_UNEXPECTED_ERROR: Unable to perform SCA operation
No request payload

Responses

SCA device registered

Bodyapplication/json
scaDeviceIdstring(uuid)required
activationQrCodeDatastringrequired
activationCodestringrequired
activationCodeSignaturestringrequired
Response
application/json
{ "scaDeviceId": "d791c6b4-56ca-4e8c-b392-93c03b92b30b", "activationQrCodeData": "string", "activationCode": "string", "activationCodeSignature": "string" }

Request

Delete the registration of an end-user device.

This operation is restricted to partner bearer tokens and should not be exposed directly to end-users.

Security
Linkcy-Auth
Path
scaDeviceIdstring(uuid)required
No request payload

Responses

SCA device deleted

Response
No content
Operations
Operations
Operations

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