Skip to content
/
Create a KYC for a consum...

Linkcy Api (1.114.5)

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
sandbox.json
sandbox.yaml
Overview
URL
https://linkcy.io/#contact
Languages
Servers
Generated server url
https://api.sandbox.linkcy.cloud/

Authentication

Operations

Strong Authentication

Operations

Partner

Operations

Webhook

Operations

End-user

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

Corporate

Operations

KYC

Operations

List KYC applications

Request

Fetch all KYC applications based on parameters. More options will be added in the near future.

Security
Linkcy-Auth
Query
sortAttributestring
Enum"CREATION_DATE""UPDATE_DATE"
personTypestring

Type of person. If empty, the query will return KYC applications of all people types.

Enum"CONSUMER""CORPORATE_RELATED_PHYSICAL_PERSON"
personIdstring(uuid)

The ID of the person. If empty, the query will return everyone KYC applications.

kycStatusstring

Search KYCs by status. If empty, the query will return KYC applications with any status.

Enum"NOT_STARTED""CREATED""PROCESSING""ABORTED""PENDING_REVIEW""VALIDATED""DECLINED"
pageSizeinteger(int32)<= 100

The size of the page to be returned.

pageinteger(int32)[ 0 .. 500 ]

The page number.

sortDirectionstring
Enum"ASC""DESC"
No request payload

Responses

OK

Bodyapplication/json
contentArray of objects(KycApplicationListElementDto)required
content[].​idstring(uuid)required
content[].​personIdstring(uuid)required
content[].​personTypestringrequired
Enum"CONSUMER""CORPORATE_RELATED_PHYSICAL_PERSON"
content[].​addressobject(AddressResponseDto)
content[].​firstNamestring
content[].​middleNamestring
content[].​lastNamestring
content[].​genderstring
Enum"MALE""FEMALE"
content[].​birthDatestring(date)
content[].​emailAddressstring
content[].​birthCitystring
content[].​birthIsoCountryCodestring
Enum"ABW""AFG""AGO""AIA""ALA""ALB""AND""ARE""ARG""ARM"
content[].​statusstringrequired
Enum"NOT_STARTED""CREATED""PROCESSING""ABORTED""PENDING_REVIEW""VALIDATED""DECLINED"
content[].​statusReasonstring
content[].​creationDatestring(date-time)required
content[].​updateDatestring(date-time)required
totalElementsinteger(int64)required
Example: 1
pageinteger(int32)required

The page number.

pageSizeinteger(int32)required

The requested page size.

Response
application/json
{
  "content": [
    { … }
  ],
  "totalElements": 1,
  "page": 0,
  "pageSize": 0
}

Create a KYC for a consumer or a corporate-related person

Request

Physical users need to complete a due diligence (KYC), this step is mandatory to be able to use banking features. Due diligence is performed with the local language of your users.

Once the field "phoneValidated" is in "true" state, you will be able to request a KYC for you consumer by link, SDK or if the KYC is delegated, you can directly provide us the results.

BY LINK:

The link is valid for 720H.

BY SDK:

We will provide you a SDK token valid for 24H that will allow one your user to perform its KYC via SDK. Do not hesitate to contact us for more information.

Note: We do not allow consumers to download pictures from the gallery.

Security
Linkcy-Auth
Bodyapplication/jsonrequired
Any of:
consumerIdstring(uuid)

Id of the consumer doing the KYC (Will be ignored and deducted from current authenticated user if end-user).

kycConfigurationDefaultKycCreateConfigurationRequestDto (object)required
DefaultKycCreateConfigurationRequestDto (object)
application/json
{
  "consumerId": "9e675a24-20d6-4913-9836-f861cd23e89e",
  "kycConfiguration": {
    "accessType": "LINK",
    "urlOnComplete": "https://google.com",
    "urlOnFailure": "https://google.com"
  }
}

Responses

KYC successfully created

Bodyapplication/json
Any of:

Id and basic information of the created KYC.

idstring(uuid)required

The identifier of the KYC application created. When making a request with the KYC SDK: you will need to add this ID in the 'externalId' payload field (in 'metadata').

tokenstringrequired

The KYC SDK JWT that you will need to use to authorize your request with the KYC SDK.

kycApiUrlstringrequired

The base URL you will need to use to create your request with the KYC SDK.

flowNamestringrequired

The KYC flow name you will need to use to create your request with the KYC SDK.

ttlstringrequired

The KYC SDK token time to live duration in ISO 8601.

Default "PT24H"
Example: "PT8H6M12.345S"
Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "token": "string",
  "kycApiUrl": "string",
  "flowName": "string",
  "ttl": "PT8H6M12.345S"
}

Get kyc application

Request

Get all information about a kyc.

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

Responses

OK

Bodyapplication/json
idstring(uuid)required
personobject(PersonInfo_Partner)required
person.​idstring(uuid)required
person.​typestringrequired
Enum"CONSUMER""CORPORATE_RELATED_PHYSICAL_PERSON"
addressobject(AddressResponseDto_Partner)

Address used on the bank statements of your users.

firstNamestring
middleNamestring
lastNamestring
genderstring
Enum"MALE""FEMALE"
birthDatestring(date)
emailAddressstring
birthCitystring
birthIsoCountryCodestring
Enum"ABW""AFG""AGO""AIA""ALA""ALB""AND""ARE""ARG""ARM"
statusobject(KycStatusInfo_Partner)required
status.​valuestringrequired
Enum"NOT_STARTED""CREATED""PROCESSING""ABORTED""PENDING_REVIEW""VALIDATED""DECLINED"
status.​reasonstring
accessTypestringrequired
Enum"LINK""SDK"
creationDatestring(date-time)required
updateDatestring(date-time)required
Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "person": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "type": "CONSUMER"
  },
  "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",
  "gender": "MALE",
  "birthDate": "2019-08-24",
  "emailAddress": "string",
  "birthCity": "string",
  "birthIsoCountryCode": "ABW",
  "status": {
    "value": "NOT_STARTED",
    "reason": "string"
  },
  "accessType": "LINK",
  "creationDate": "2019-08-24T14:15:22Z",
  "updateDate": "2019-08-24T14:15:22Z"
}

KYB

Operations

Documents

Operations

Ledger

Operations

Card

Operations

Acquiring

Operations

Beneficiary

Operations

Transaction

Operations

Direct Debit Mandate

Operations

Wallet

Operations

Crypto Beneficiary

Operations

Crypto Transaction

Operations

Additional

Operations

Sandbox

Operations

Web Pages

Operations