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.
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.
This is the first step to create an Individual consumer. Phone object is mandatory to be able to go on to the next steps. You can add optional fields, this will help us to manage compliance triggers.
Only a few pieces of information are asked here, most of it will be extracted from documents during the KYC process. By doing the Endpoint: Get Consumer information, you will get access to all data.
You cannot create two consumers with the same phone number. Phone numbers must be unique.
The partnerName, mandatory if you create a consumer as anonymous. Ignored if requesting as a partner.
A unique identifier that you can use to link this consumer to a user in your system.
Description of source of funds if 'OTHER' was chosen.
The consumer usual or principal work or business as a means of earning a living.
The consumer usual or principal work or business sector.
The version of the terms and conditions signed by the consumer.
{ "partnerName": "string", "firstName": "string", "middleName": "string", "lastName": "string", "externalId": "string", "phone": { "countryCode": "33", "number": "string" }, "address": { "isoCountryCode": "AUT", "city": "string", "postalCode": "string", "street": "string", "number": "string", "refinement": "string", "stateOrProvince": "string", "bypassVerification": true }, "emailAddress": "string", "sourceOfFunds": "COMPENSATION_PAYOUT", "otherSourceOfFunds": "string", "occupation": "BUSINESS_OWNER", "otherOccupation": "string", "occupationSector": "ACCOUNTING_AUDIT", "isUsPerson": true, "lastTermsAccepted": "1.0", "taxIdentificationNumber": "string", "taxCountry": "AUT", "accountPurposes": [ "PAY_BILLS" ], "financialInformation": { "monthlyNetIncome": "LESS_THAN_1000", "currency": "EUR", "expectedMonthlyIncomingVolume": "LESS_THAN_1000", "expectedMonthlyOutgoingVolume": "LESS_THAN_1000", "expectedMonthlyIncomingTransferFrequency": "LESS_THAN_TWO_TIMES" }, "metadata": { "property1": {}, "property2": {} } }
{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08" }
No request payloadOK
{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "externalId": "string", "phone": { "countryCode": "string", "number": "string", "verified": true, "verificationDate": "2019-08-24T14:15:22Z" }, "kycInfo": { "kycApplicationId": "79d915d9-9648-4a89-9125-d56b7a19df65", "status": "NOT_STARTED", "statusReason": "string", "type": "FULL_KYC", "updateDate": "2019-08-24T14:15:22Z" }, "status": { "banking": { … }, "kyc": { … }, "suspension": { … }, "linkcy": { … }, "compliance": { … }, "overall": { … } }, "termsAccepted": true, "address": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "isoCountryCode": "ABW", "city": "string", "postalCode": "string", "street": "string", "number": "string", "refinement": "string", "stateOrProvince": "string", "status": "INVALID" }, "firstName": "string", "middleName": "string", "lastName": "string", "email": { "address": "string", "verified": true, "verificationDate": "2019-08-24T14:15:22Z" }, "gender": "MALE", "birthCity": "string", "birthIsoCountryCode": "ABW", "nationalityCode": "ABW", "birthDate": "2019-08-24", "sourceOfFunds": "COMPENSATION_PAYOUT", "otherSourceOfFunds": "string", "occupation": "BUSINESS_OWNER", "otherOccupation": "string", "notes": "string", "creationDate": "2019-08-24T14:15:22Z", "updateDate": "2019-08-24T14:15:22Z", "taxIdentificationNumber": "string", "taxCountry": "ABW", "accountPurposes": [ "PAY_BILLS" ], "strongAuthentication": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "endpointId": "string", "creationDate": "2019-08-24T14:15:22Z", "pinStatus": "SET", "biometryStatus": "SET" }, "scaDevices": [ { … } ], "financialInformation": { "monthlyNetIncome": "LESS_THAN_1000", "currency": "EUR", "expectedMonthlyIncomingVolume": "LESS_THAN_1000", "expectedMonthlyOutgoingVolume": "LESS_THAN_1000", "expectedMonthlyIncomingTransferFrequency": "LESS_THAN_TWO_TIMES" }, "partnerMetadata": {}, "userMetadata": {} }
You can patch a consumer to update some information. Depending on the information patched, you will have to perform another action:
External ID -> no action 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.
Source of funds -> no action to perform
Occupation -> no action to perform
Terms & Condition -> Needed if "termsAccepted" is "false".
A unique identifier that you can use to link this consumer to a user in your system.
Description of source of funds if 'OTHER' was chosen.
The consumer usual or principal work or business as a means of earning a living.
The consumer usual or principal work or business sector.
The version of the terms and conditions signed by the consumer.
A custom field to save data.
This field's size is limited to 3000 characters.
{ "externalId": "string", "sourceOfFunds": "COMPENSATION_PAYOUT", "otherSourceOfFunds": "string", "occupation": "BUSINESS_OWNER", "otherOccupation": "string", "occupationSector": "ACCOUNTING_AUDIT", "isUsPerson": true, "lastTermsAccepted": "1.0", "taxIdentificationNumber": "string", "taxCountry": "AUT", "accountPurposes": [ "PAY_BILLS" ], "financialInformationRequestDto": { "monthlyNetIncome": "LESS_THAN_1000", "currency": "EUR", "expectedMonthlyIncomingVolume": "LESS_THAN_1000", "expectedMonthlyOutgoingVolume": "LESS_THAN_1000", "expectedMonthlyIncomingTransferFrequency": "LESS_THAN_TWO_TIMES" }, "userMetadata": { "property1": {}, "property2": {} }, "partnerMetadata": { "property1": {}, "property2": {} } }
{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "updateDate": "2019-08-24T14:15:22Z" }